From 09633096324cf019338185584901f5a872c670eb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:43 +0000 Subject: [PATCH 01/31] chore: update docs/dyn/index.md --- docs/dyn/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 0cba7c52da..e31b75d7b5 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -1141,6 +1141,7 @@ ## saasservicemgmt +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/saasservicemgmt_v1.html) * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/saasservicemgmt_v1beta1.html) From 5577adf2b4a615e185fc5f46b3255588165ca97b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:43 +0000 Subject: [PATCH 02/31] feat(admin): update the api #### admin:reports_v1 The following keys were added: - schemas.CustomerIdentity (Total Keys: 3) - schemas.GroupIdentity (Total Keys: 4) - schemas.OwnerDetails (Total Keys: 5) - schemas.OwnerIdentity (Total Keys: 5) - schemas.ResourceDetails.properties.ownerDetails.$ref (Total Keys: 1) - schemas.UserIdentity (Total Keys: 4) --- docs/dyn/admin_reports_v1.activities.html | 20 ++++- .../documents/admin.reports_v1.json | 86 ++++++++++++++++++- 2 files changed, 103 insertions(+), 3 deletions(-) diff --git a/docs/dyn/admin_reports_v1.activities.html b/docs/dyn/admin_reports_v1.activities.html index 003badf70f..98fa9f3374 100644 --- a/docs/dyn/admin_reports_v1.activities.html +++ b/docs/dyn/admin_reports_v1.activities.html @@ -320,7 +320,25 @@

Method Details

"title": "A String", # Title of the label }, ], - "id": "A String", # Identifier of the resource. + "id": "A String", # Identifier of the resource, such as a doc_id for a Drive document, a conference_id for a Meet conference, or a "gaia_id/rfc2822_message_id" for an email. + "ownerDetails": { # Details of the owner of the resource. # Owner details of the resource. + "ownerIdentity": [ # Identity details of the owner(s) of the resource. + { # Identity details of the owner of the resource. + "customerIdentity": { # Identity of the Google Workspace customer who owns the resource. # Identity of the Google Workspace customer who owns the resource. + "id": "A String", # Customer id. + }, + "groupIdentity": { # Identity of the group who owns the resource. # Identity of the group who owns the resource. + "groupEmail": "A String", # Group email. + "id": "A String", # Group gaia id. + }, + "userIdentity": { # Identity of the user who owns the resource. # Identity of the user who owns the resource. + "id": "A String", # User gaia id. + "userEmail": "A String", # User email. + }, + }, + ], + "ownerType": "A String", # Type of the owner of the resource. + }, "relation": "A String", # Defines relationship of the resource to the events "title": "A String", # Title of the resource. For instance, in case of a drive document, this would be the title of the document. In case of an email, this would be the subject. "type": "A String", # Type of the resource - document, email, chat message diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json index 01922b5aa0..caf7d6c7bb 100644 --- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json @@ -681,7 +681,7 @@ } } }, -"revision": "20260223", +"revision": "20260311", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { @@ -1033,6 +1033,17 @@ }, "type": "object" }, +"CustomerIdentity": { +"description": "Identity of the Google Workspace customer who owns the resource.", +"id": "CustomerIdentity", +"properties": { +"id": { +"description": "Customer id.", +"type": "string" +} +}, +"type": "object" +}, "Date": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date", @@ -1191,6 +1202,21 @@ }, "type": "object" }, +"GroupIdentity": { +"description": "Identity of the group who owns the resource.", +"id": "GroupIdentity", +"properties": { +"groupEmail": { +"description": "Group email.", +"type": "string" +}, +"id": { +"description": "Group gaia id.", +"type": "string" +} +}, +"type": "object" +}, "NestedParameter": { "description": "JSON template for a parameter used in various reports.", "id": "NestedParameter", @@ -1237,6 +1263,43 @@ }, "type": "object" }, +"OwnerDetails": { +"description": "Details of the owner of the resource.", +"id": "OwnerDetails", +"properties": { +"ownerIdentity": { +"description": "Identity details of the owner(s) of the resource.", +"items": { +"$ref": "OwnerIdentity" +}, +"type": "array" +}, +"ownerType": { +"description": "Type of the owner of the resource.", +"type": "string" +} +}, +"type": "object" +}, +"OwnerIdentity": { +"description": "Identity details of the owner of the resource.", +"id": "OwnerIdentity", +"properties": { +"customerIdentity": { +"$ref": "CustomerIdentity", +"description": "Identity of the Google Workspace customer who owns the resource." +}, +"groupIdentity": { +"$ref": "GroupIdentity", +"description": "Identity of the group who owns the resource." +}, +"userIdentity": { +"$ref": "UserIdentity", +"description": "Identity of the user who owns the resource." +} +}, +"type": "object" +}, "Reason": { "description": "The reason why the label/field was applied.", "id": "Reason", @@ -1260,9 +1323,13 @@ "type": "array" }, "id": { -"description": "Identifier of the resource.", +"description": "Identifier of the resource, such as a doc_id for a Drive document, a conference_id for a Meet conference, or a \"gaia_id/rfc2822_message_id\" for an email.", "type": "string" }, +"ownerDetails": { +"$ref": "OwnerDetails", +"description": "Owner details of the resource." +}, "relation": { "description": "Defines relationship of the resource to the events", "type": "string" @@ -1438,6 +1505,21 @@ } }, "type": "object" +}, +"UserIdentity": { +"description": "Identity of the user who owns the resource.", +"id": "UserIdentity", +"properties": { +"id": { +"description": "User gaia id.", +"type": "string" +}, +"userEmail": { +"description": "User email.", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", From f4eee62a0eb42e6b82648abd8aa10dfb1aa37d16 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:43 +0000 Subject: [PATCH 03/31] feat(aiplatform): update the api #### aiplatform:v1 The following keys were added: - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.create.parameters.memoryId (Total Keys: 2) - resources.projects.resources.locations.resources.reasoningEngines.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - schemas.GoogleCloudAiplatformV1DatasetCustomMetric (Total Keys: 3) - schemas.GoogleCloudAiplatformV1EmbedContentRequest.properties.embedContentConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EmbedContentRequestEmbedContentConfig (Total Keys: 8) - schemas.GoogleCloudAiplatformV1EvaluationRunEvaluationConfig.properties.datasetCustomMetrics (Total Keys: 2) - schemas.GoogleCloudAiplatformV1MemoryBankCustomizationConfig.properties.consolidationConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1MemoryBankCustomizationConfigConsolidationConfig (Total Keys: 2) - schemas.GoogleCloudAiplatformV1SessionEvent.properties.rawEvent (Total Keys: 2) #### aiplatform:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.create.parameters.memoryId (Total Keys: 2) - resources.projects.resources.locations.resources.reasoningEngines.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.reasoningEngines.resources.memories.methods.create.parameters.memoryId (Total Keys: 2) - resources.reasoningEngines.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1DatasetCustomMetric (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1EmbedContentRequest.properties.embedContentConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EmbedContentRequestEmbedContentConfig (Total Keys: 8) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig.properties.datasetCustomMetrics (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig.properties.agentConfig.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig.properties.consolidationConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigConsolidationConfig (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1SessionEvent.properties.rawEvent (Total Keys: 2) --- docs/dyn/aiplatform_v1.endpoints.html | 140 ++-- ..._v1.projects.locations.cachedContents.html | 204 ++--- ...tform_v1.projects.locations.endpoints.html | 140 ++-- ...v1.projects.locations.evaluationItems.html | 112 +-- ..._v1.projects.locations.evaluationRuns.html | 28 +- .../dyn/aiplatform_v1.projects.locations.html | 312 +++---- ....projects.locations.publishers.models.html | 162 ++-- ...1.projects.locations.reasoningEngines.html | 76 +- ...s.locations.reasoningEngines.memories.html | 19 +- ...ions.reasoningEngines.sessions.events.html | 17 +- ...s.locations.reasoningEngines.sessions.html | 22 +- ...form_v1.projects.locations.tuningJobs.html | 210 ++--- docs/dyn/aiplatform_v1.publishers.models.html | 142 ++-- docs/dyn/aiplatform_v1.reasoningEngines.html | 76 +- docs/dyn/aiplatform_v1.v1.html | 194 ++--- docs/dyn/aiplatform_v1beta1.endpoints.html | 140 ++-- ...ta1.projects.locations.cachedContents.html | 204 ++--- ...m_v1beta1.projects.locations.datasets.html | 68 +- ..._v1beta1.projects.locations.endpoints.html | 140 ++-- ...a1.projects.locations.evaluationItems.html | 768 +++++++++--------- ...ta1.projects.locations.evaluationRuns.html | 100 ++- ...eta1.projects.locations.exampleStores.html | 126 +-- ...v1beta1.projects.locations.extensions.html | 28 +- ...aiplatform_v1beta1.projects.locations.html | 330 ++++---- ....projects.locations.publishers.models.html | 162 ++-- ...1.projects.locations.reasoningEngines.html | 81 +- ...s.locations.reasoningEngines.memories.html | 19 +- ...ons.reasoningEngines.runtimeRevisions.html | 91 +++ ...ngEngines.runtimeRevisions.operations.html | 272 +++++++ ...ions.reasoningEngines.sessions.events.html | 17 +- ...s.locations.reasoningEngines.sessions.html | 22 +- ...v1beta1.projects.locations.tuningJobs.html | 308 +++---- .../aiplatform_v1beta1.publishers.models.html | 144 ++-- .../aiplatform_v1beta1.reasoningEngines.html | 81 +- ...orm_v1beta1.reasoningEngines.memories.html | 19 +- ...ta1.reasoningEngines.runtimeRevisions.html | 91 +++ ...ngEngines.runtimeRevisions.operations.html | 272 +++++++ ...eta1.reasoningEngines.sessions.events.html | 17 +- ...orm_v1beta1.reasoningEngines.sessions.html | 22 +- docs/dyn/aiplatform_v1beta1.v1beta1.html | 212 ++--- .../documents/aiplatform.v1.json | 198 ++++- .../documents/aiplatform.v1beta1.json | 525 +++++++++++- 42 files changed, 3864 insertions(+), 2447 deletions(-) create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.operations.html diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index ab1b14a267..26a6612b79 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -128,11 +128,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`. }, @@ -141,11 +141,11 @@

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. }, - "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. @@ -158,8 +158,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -243,11 +243,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`. }, @@ -256,11 +256,11 @@

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. }, - "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. @@ -273,8 +273,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -435,11 +435,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`. }, @@ -448,11 +448,11 @@

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. }, - "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. @@ -465,8 +465,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -508,7 +508,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. @@ -801,11 +801,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`. }, @@ -814,11 +814,11 @@

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. }, - "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. @@ -831,8 +831,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1003,11 +1003,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`. }, @@ -1016,11 +1016,11 @@

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. }, - "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. @@ -1033,8 +1033,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1076,11 +1076,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. @@ -1092,7 +1092,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. @@ -1339,11 +1339,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`. }, @@ -1352,11 +1352,11 @@

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. }, - "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. @@ -1369,8 +1369,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1696,11 +1696,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`. }, @@ -1709,11 +1709,11 @@

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. }, - "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. @@ -1726,8 +1726,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1898,11 +1898,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`. }, @@ -1911,11 +1911,11 @@

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. }, - "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. @@ -1928,8 +1928,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1971,11 +1971,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. @@ -1987,7 +1987,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. @@ -2234,11 +2234,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`. }, @@ -2247,11 +2247,11 @@

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. }, - "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. @@ -2264,8 +2264,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index ebdc1bfa66..08987a541a 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -115,11 +115,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`. }, @@ -128,11 +128,11 @@

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. }, - "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. @@ -145,8 +145,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -198,11 +198,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -211,11 +211,11 @@

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. }, - "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. @@ -228,8 +228,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -271,11 +271,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -287,7 +287,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -525,11 +525,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`. }, @@ -538,11 +538,11 @@

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. }, - "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. @@ -555,8 +555,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -608,11 +608,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -621,11 +621,11 @@

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. }, - "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. @@ -638,8 +638,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -681,11 +681,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -697,7 +697,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -960,11 +960,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`. }, @@ -973,11 +973,11 @@

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. }, - "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. @@ -990,8 +990,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1043,11 +1043,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -1056,11 +1056,11 @@

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. }, - "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. @@ -1073,8 +1073,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1116,11 +1116,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -1132,7 +1132,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -1381,11 +1381,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`. }, @@ -1394,11 +1394,11 @@

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. }, - "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. @@ -1411,8 +1411,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1464,11 +1464,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. Input only. Immutable. Developer set system instruction. Currently, text only "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,11 +1477,11 @@

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. }, - "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. @@ -1494,8 +1494,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1537,11 +1537,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -1553,7 +1553,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -1810,11 +1810,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`. }, @@ -1823,11 +1823,11 @@

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. }, - "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. @@ -1840,8 +1840,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1893,11 +1893,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -1906,11 +1906,11 @@

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. }, - "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. @@ -1923,8 +1923,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1966,11 +1966,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -1982,7 +1982,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -2221,11 +2221,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`. }, @@ -2234,11 +2234,11 @@

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. }, - "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. @@ -2251,8 +2251,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2304,11 +2304,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -2317,11 +2317,11 @@

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. }, - "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. @@ -2334,8 +2334,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2377,11 +2377,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -2393,7 +2393,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 815b2b2a12..e3bb6f47ee 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -196,11 +196,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`. }, @@ -209,11 +209,11 @@

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. }, - "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. @@ -226,8 +226,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -311,11 +311,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`. }, @@ -324,11 +324,11 @@

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. }, - "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. @@ -341,8 +341,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -503,11 +503,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`. }, @@ -516,11 +516,11 @@

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. }, - "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. @@ -533,8 +533,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -576,7 +576,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. @@ -1765,11 +1765,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`. }, @@ -1778,11 +1778,11 @@

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. }, - "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. @@ -1795,8 +1795,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1967,11 +1967,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`. }, @@ -1980,11 +1980,11 @@

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. }, - "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. @@ -1997,8 +1997,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2040,11 +2040,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. @@ -2056,7 +2056,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. @@ -2303,11 +2303,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`. }, @@ -2316,11 +2316,11 @@

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. }, - "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. @@ -2333,8 +2333,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4142,11 +4142,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`. }, @@ -4155,11 +4155,11 @@

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. }, - "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. @@ -4172,8 +4172,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4344,11 +4344,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`. }, @@ -4357,11 +4357,11 @@

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. }, - "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. @@ -4374,8 +4374,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4417,11 +4417,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. @@ -4433,7 +4433,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. @@ -4680,11 +4680,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`. }, @@ -4693,11 +4693,11 @@

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. }, - "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. @@ -4710,8 +4710,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html index 48098ec13f..8d74993101 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -157,11 +157,11 @@

Method Details

"a_key": { # 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`. }, @@ -170,11 +170,11 @@

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. }, - "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. @@ -187,8 +187,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -319,11 +319,11 @@

Method Details

"a_key": { # 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`. }, @@ -332,11 +332,11 @@

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. }, - "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. @@ -349,8 +349,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -481,11 +481,11 @@

Method Details

"a_key": { # 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`. }, @@ -494,11 +494,11 @@

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. }, - "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. @@ -511,8 +511,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -643,11 +643,11 @@

Method Details

"a_key": { # 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`. }, @@ -656,11 +656,11 @@

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. }, - "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. @@ -673,8 +673,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -847,11 +847,11 @@

Method Details

"a_key": { # 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`. }, @@ -860,11 +860,11 @@

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. }, - "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. @@ -877,8 +877,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1009,11 +1009,11 @@

Method Details

"a_key": { # 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`. }, @@ -1022,11 +1022,11 @@

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. }, - "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. @@ -1039,8 +1039,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1184,11 +1184,11 @@

Method Details

"a_key": { # 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`. }, @@ -1197,11 +1197,11 @@

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. }, - "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. @@ -1214,8 +1214,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1346,11 +1346,11 @@

Method Details

"a_key": { # 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`. }, @@ -1359,11 +1359,11 @@

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. }, - "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. @@ -1376,8 +1376,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 91a8d1d5c5..93be21e9d1 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -281,6 +281,11 @@

Method Details

}, "sampleCount": 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. }, + "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. + { # Defines a custom dataset-level aggregation. + "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -1389,7 +1394,7 @@

Method Details

"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. }, - "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -1555,6 +1560,11 @@

Method Details

}, "sampleCount": 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. }, + "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. + { # Defines a custom dataset-level aggregation. + "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -2663,7 +2673,7 @@

Method Details

"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. }, - "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -2871,6 +2881,11 @@

Method Details

}, "sampleCount": 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. }, + "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. + { # Defines a custom dataset-level aggregation. + "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -3979,7 +3994,7 @@

Method Details

"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. }, - "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -4158,6 +4173,11 @@

Method Details

}, "sampleCount": 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. }, + "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. + { # Defines a custom dataset-level aggregation. + "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -5266,7 +5286,7 @@

Method Details

"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. }, - "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index d4df06652c..5320f511e8 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -288,7 +288,7 @@

Instance Methods

Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.

generateSyntheticData(location, body=None, x__xgafv=None)

-

Generates synthetic data based on the provided configuration.

+

Generates synthetic (artificial) data based on a description

get(name, x__xgafv=None)

Gets information about a location.

@@ -339,7 +339,7 @@

Method Details

}, "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. + "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. @@ -616,7 +616,7 @@

Method Details

}, "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. + "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. @@ -875,11 +875,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`. }, @@ -888,11 +888,11 @@

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. }, - "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. @@ -905,8 +905,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -994,11 +994,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`. }, @@ -1007,11 +1007,11 @@

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. }, - "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. @@ -1024,8 +1024,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1104,11 +1104,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. # Optional. Input content to corroborate, only text format is supported for now. "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`. }, @@ -1117,11 +1117,11 @@

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. }, - "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. @@ -1134,8 +1134,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2141,11 +2141,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`. }, @@ -2154,11 +2154,11 @@

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. }, - "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. @@ -2171,8 +2171,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2222,7 +2222,7 @@

Method Details

"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. + "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. @@ -2450,11 +2450,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`. }, @@ -2463,11 +2463,11 @@

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. }, - "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. @@ -2480,8 +2480,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2531,7 +2531,7 @@

Method Details

"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. + "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. @@ -2755,11 +2755,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`. }, @@ -2768,11 +2768,11 @@

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. }, - "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. @@ -2785,8 +2785,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2835,11 +2835,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`. }, @@ -2848,11 +2848,11 @@

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. }, - "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. @@ -2865,8 +2865,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2911,7 +2911,7 @@

Method Details

"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. + "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. @@ -3133,7 +3133,7 @@

Method Details

{ # 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. + "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. @@ -3351,11 +3351,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. # 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. + "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`. }, @@ -3364,11 +3364,11 @@

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. }, - "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. @@ -3381,8 +3381,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -3433,7 +3433,7 @@

Method Details

}, ], }, - "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. + "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. `prompt`), the value of the field will take precedence over the value in other_data. "mapInstance": { # Optional. Map of instance data. "a_key": { # Instance data used to populate placeholders in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. @@ -3441,11 +3441,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`. }, @@ -3454,11 +3454,11 @@

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. }, - "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. @@ -3471,8 +3471,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -3524,11 +3524,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`. }, @@ -3537,11 +3537,11 @@

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. }, - "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. @@ -3554,8 +3554,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -3605,11 +3605,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`. }, @@ -3618,11 +3618,11 @@

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. }, - "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. @@ -3635,8 +3635,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -3686,11 +3686,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`. }, @@ -3699,11 +3699,11 @@

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. }, - "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. @@ -3716,8 +3716,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4107,11 +4107,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`. }, @@ -4120,11 +4120,11 @@

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. }, - "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. @@ -4137,8 +4137,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4229,11 +4229,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`. }, @@ -4242,11 +4242,11 @@

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. }, - "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. @@ -4259,8 +4259,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4867,11 +4867,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`. }, @@ -4880,11 +4880,11 @@

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. }, - "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. @@ -4897,8 +4897,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4948,7 +4948,7 @@

Method Details

"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. + "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. @@ -5169,11 +5169,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`. }, @@ -5182,11 +5182,11 @@

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. }, - "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. @@ -5199,8 +5199,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -5401,27 +5401,27 @@

Method Details

generateSyntheticData(location, body=None, x__xgafv=None) -
Generates synthetic data based on the provided configuration.
+  
Generates synthetic (artificial) data based on a description
 
 Args:
-  location: string, Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}` (required)
+  location: string, Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project}/locations/{location}`. For example, `projects/my-project/locations/us-central1`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for DataFoundryService.GenerateSyntheticData.
-  "count": 42, # Required. The number of synthetic examples to generate. For this stateless API, the count is limited to a small number.
-  "examples": [ # Optional. A list of few-shot examples to guide the model's output style and format.
-    { # Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response.
+{ # Request message for DataFoundryService.GenerateSyntheticData. It contains the settings and information needed to generate synthetic data.
+  "count": 42, # Required. The number of synthetic examples to generate. For this stateless API, you can generate up to 50 examples in a single request.
+  "examples": [ # Optional. A list of few-shot examples that help the model understand the desired style, tone, and format of the generated synthetic data. Providing these few-shot examples can significantly improve the quality and relevance of the output.
+    { # A single instance of generated synthetic data. Each example is made up of one or more named fields, as defined in `OutputFieldSpec`. These examples are used as few-shot examples to show the model what you want (in `GenerateSyntheticDataRequest.examples`) and to return generated examples in the response (in `GenerateSyntheticDataResponse.synthetic_examples`).
       "fields": [ # Required. A list of fields that constitute an example.
-        { # Represents a single named field within a SyntheticExample.
-          "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 field.
+        { # Represents a single named field within a synthetic example, consisting of a name and the actual content.
+          "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 actual content or value for this field. This can be text, images, or other types of data.
             "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`.
                 },
@@ -5430,11 +5430,11 @@ 

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. }, - "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. @@ -5447,8 +5447,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -5488,20 +5488,20 @@

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'. }, - "fieldName": "A String", # Optional. The name of the field. + "fieldName": "A String", # Optional. The name of the specific field, such as "product_name" or "review_text". }, ], }, ], - "outputFieldSpecs": [ # Required. The schema of the desired output, defined by a list of fields. - { # Defines a specification for a single output field. - "fieldName": "A String", # Required. The name of the output field. + "outputFieldSpecs": [ # Required. Defines the schema of each synthetic example to be generated, defined by a list of fields. + { # Specifies the properties of a single field that are included in each generated synthetic example. This helps the model understand what kind of data to generate for each field. + "fieldName": "A String", # Required. The name of this field in the generated synthetic data, such as "email_subject" or "customer_review". "fieldType": "A String", # Optional. The data type of the field. Defaults to CONTENT if not set. - "guidance": "A String", # Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred. + "guidance": "A String", # Optional. Specific instructions for the large language model on how to generate content for this particular field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred. For example, for a field named "review", the guidance could be "A positive review about a coffee maker." }, ], - "taskDescription": { # Defines a generation strategy based on a high-level task description. # Generate data from a high-level task description. - "taskDescription": "A String", # Required. A high-level description of the synthetic data to be generated. + "taskDescription": { # Defines a generation strategy based on a general task description. # Generates synthetic data based on a high-level description of the task or data you want. + "taskDescription": "A String", # Required. A general description of the type of synthetic data you want to generate. For example, "Generate customer reviews for a new smartphone." }, } @@ -5513,19 +5513,19 @@

Method Details

Returns: An object of the form: - { # The response containing the generated data. - "syntheticExamples": [ # A list of generated synthetic examples. - { # Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response. + { # The response message for the `GenerateSyntheticData` method, containing the synthetic examples generated by the Gen AI evaluation service. + "syntheticExamples": [ # A list of generated synthetic examples, each containing a complete synthetic data instance generated based on your request. + { # A single instance of generated synthetic data. Each example is made up of one or more named fields, as defined in `OutputFieldSpec`. These examples are used as few-shot examples to show the model what you want (in `GenerateSyntheticDataRequest.examples`) and to return generated examples in the response (in `GenerateSyntheticDataResponse.synthetic_examples`). "fields": [ # Required. A list of fields that constitute an example. - { # Represents a single named field within a SyntheticExample. - "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 field. + { # Represents a single named field within a synthetic example, consisting of a name and the actual content. + "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 actual content or value for this field. This can be text, images, or other types of data. "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`. }, @@ -5534,11 +5534,11 @@

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. }, - "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. @@ -5551,8 +5551,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -5592,7 +5592,7 @@

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'. }, - "fieldName": "A String", # Optional. The name of the field. + "fieldName": "A String", # Optional. The name of the specific field, such as "product_name" or "review_text". }, ], }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 3504e9084e..1c8de8653d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -135,11 +135,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`. }, @@ -148,11 +148,11 @@

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. }, - "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. @@ -165,8 +165,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -250,11 +250,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`. }, @@ -263,11 +263,11 @@

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. }, - "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. @@ -280,8 +280,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -442,11 +442,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`. }, @@ -455,11 +455,11 @@

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. }, - "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. @@ -472,8 +472,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -515,7 +515,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. @@ -765,11 +765,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. # 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. + "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`. }, @@ -778,11 +778,11 @@

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. }, - "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. @@ -795,8 +795,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -836,6 +836,14 @@

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'. }, + "embedContentConfig": { # Configurations for the EmbedContent API. # Optional. Configuration for the EmbedContent request. + "audioTrackExtraction": True or False, # Optional. Whether to extract audio from video content. + "autoTruncate": True or False, # Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length. Only applicable to text-only embedding models. + "documentOcr": True or False, # Optional. Whether to enable OCR for document content. + "outputDimensionality": 42, # 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. Only applicable to text-only embedding models. + "title": "A String", # Optional. The title for the text. Only applicable to text-only embedding models. + }, "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. @@ -949,11 +957,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`. }, @@ -962,11 +970,11 @@

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. }, - "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. @@ -979,8 +987,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1151,11 +1159,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`. }, @@ -1164,11 +1172,11 @@

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. }, - "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. @@ -1181,8 +1189,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1224,11 +1232,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. @@ -1240,7 +1248,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. @@ -1487,11 +1495,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`. }, @@ -1500,11 +1508,11 @@

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. }, - "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. @@ -1517,8 +1525,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2072,11 +2080,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`. }, @@ -2085,11 +2093,11 @@

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. }, - "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. @@ -2102,8 +2110,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2274,11 +2282,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`. }, @@ -2287,11 +2295,11 @@

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. }, - "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. @@ -2304,8 +2312,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2347,11 +2355,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. @@ -2363,7 +2371,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. @@ -2610,11 +2618,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`. }, @@ -2623,11 +2631,11 @@

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. }, - "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. @@ -2640,8 +2648,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html index f7a388bf9e..a4fbf25e7f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html @@ -152,7 +152,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -162,11 +165,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. # Required. The content of the event. "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`. }, @@ -175,11 +178,11 @@

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. }, - "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. @@ -192,8 +195,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -499,7 +502,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -509,11 +515,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. # Required. The content of the event. "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`. }, @@ -522,11 +528,11 @@

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. }, - "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. @@ -539,8 +545,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -777,7 +783,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -787,11 +796,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. # Required. The content of the event. "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`. }, @@ -800,11 +809,11 @@

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. }, - "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. @@ -817,8 +826,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1025,7 +1034,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -1035,11 +1047,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. # Required. The content of the event. "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`. }, @@ -1048,11 +1060,11 @@

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. }, - "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. @@ -1065,8 +1077,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html index 9805c84c51..fd71aed8b7 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html @@ -88,7 +88,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, x__xgafv=None)

+ create(parent, body=None, memoryId=None, x__xgafv=None)

Create a Memory.

delete(name, x__xgafv=None)

@@ -124,7 +124,7 @@

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, memoryId=None, x__xgafv=None)
Create a Memory.
 
 Args:
@@ -166,6 +166,7 @@ 

Method Details

"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. } + memoryId: string, Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -246,11 +247,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. # Required. A single piece of content from which to generate memories. "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`. }, @@ -259,11 +260,11 @@

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. }, - "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. @@ -276,8 +277,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. 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 747ce26473..dcc2519a33 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html @@ -129,11 +129,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. # Optional. Content of the event provided by the author. "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`. }, @@ -142,11 +142,11 @@

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. }, - "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. @@ -159,8 +159,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -313,6 +313,9 @@

Method Details

}, "invocationId": "A String", # Required. The invocation id of the event, multiple events can have the same invocation id. "name": "A String", # Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`. + "rawEvent": { # Optional. Weakly typed raw event data in proto struct format. + "a_key": "", # Properties of the object. + }, "timestamp": "A String", # Required. Timestamp when the event was created on client side. }, ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html index 86ab40efd0..eacfd09d51 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html @@ -91,7 +91,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, x__xgafv=None)

+ create(parent, body=None, sessionId=None, x__xgafv=None)

Creates a new Session.

delete(name, x__xgafv=None)

@@ -137,11 +137,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. # Optional. Content of the event provided by the author. "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`. }, @@ -150,11 +150,11 @@

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. }, - "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. @@ -167,8 +167,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -321,6 +321,9 @@

Method Details

}, "invocationId": "A String", # Required. The invocation id of the event, multiple events can have the same invocation id. "name": "A String", # Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`. + "rawEvent": { # Optional. Weakly typed raw event data in proto struct format. + "a_key": "", # Properties of the object. + }, "timestamp": "A String", # Required. Timestamp when the event was created on client side. } @@ -342,7 +345,7 @@

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a new Session.
 
 Args:
@@ -366,6 +369,7 @@ 

Method Details

"userId": "A String", # Required. Immutable. String id provided by the user } + sessionId: string, Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 1b7886c825..adcff101e5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -868,11 +868,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -881,11 +881,11 @@

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. }, - "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. @@ -898,8 +898,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -946,11 +946,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`. }, @@ -959,11 +959,11 @@

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. }, - "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. @@ -976,8 +976,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1070,11 +1070,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`. }, @@ -1083,11 +1083,11 @@

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. }, - "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. @@ -1100,8 +1100,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1935,11 +1935,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -1948,11 +1948,11 @@

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. }, - "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. @@ -1965,8 +1965,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2013,11 +2013,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`. }, @@ -2026,11 +2026,11 @@

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. }, - "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. @@ -2043,8 +2043,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2137,11 +2137,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`. }, @@ -2150,11 +2150,11 @@

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. }, - "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. @@ -2167,8 +2167,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -3009,11 +3009,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -3022,11 +3022,11 @@

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. }, - "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. @@ -3039,8 +3039,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -3087,11 +3087,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`. }, @@ -3100,11 +3100,11 @@

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. }, - "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. @@ -3117,8 +3117,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -3211,11 +3211,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`. }, @@ -3224,11 +3224,11 @@

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. }, - "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. @@ -3241,8 +3241,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4089,11 +4089,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -4102,11 +4102,11 @@

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. }, - "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. @@ -4119,8 +4119,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4167,11 +4167,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`. }, @@ -4180,11 +4180,11 @@

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. }, - "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. @@ -4197,8 +4197,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -4291,11 +4291,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`. }, @@ -4304,11 +4304,11 @@

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. }, - "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. @@ -4321,8 +4321,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -5184,11 +5184,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -5197,11 +5197,11 @@

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. }, - "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. @@ -5214,8 +5214,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -5262,11 +5262,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`. }, @@ -5275,11 +5275,11 @@

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. }, - "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. @@ -5292,8 +5292,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -5386,11 +5386,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`. }, @@ -5399,11 +5399,11 @@

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. }, - "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. @@ -5416,8 +5416,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 84e972dbc1..9ffabc74e8 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -121,11 +121,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`. }, @@ -134,11 +134,11 @@

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. }, - "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. @@ -151,8 +151,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -236,11 +236,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`. }, @@ -249,11 +249,11 @@

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. }, - "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. @@ -266,8 +266,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -428,11 +428,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`. }, @@ -441,11 +441,11 @@

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. }, - "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. @@ -458,8 +458,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -501,7 +501,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. @@ -794,11 +794,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`. }, @@ -807,11 +807,11 @@

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. }, - "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. @@ -824,8 +824,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -996,11 +996,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`. }, @@ -1009,11 +1009,11 @@

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. }, - "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. @@ -1026,8 +1026,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1069,11 +1069,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. @@ -1085,7 +1085,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. @@ -1332,11 +1332,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`. }, @@ -1345,11 +1345,11 @@

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. }, - "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. @@ -1362,8 +1362,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1618,7 +1618,7 @@

Method Details

"A String", ], "launchStage": "A String", # Optional. Indicates the launch stage of the model. - "name": "A String", # Output only. The resource name of the PublisherModel. + "name": "A String", # Output only. Identifier. The resource name of the PublisherModel. "openSourceCategory": "A String", # Required. Indicates the open source category of the publisher model. "predictSchemata": { # Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. # Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict. "instanceSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. @@ -2264,11 +2264,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`. }, @@ -2277,11 +2277,11 @@

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. }, - "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. @@ -2294,8 +2294,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2466,11 +2466,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`. }, @@ -2479,11 +2479,11 @@

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. }, - "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. @@ -2496,8 +2496,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2539,11 +2539,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. @@ -2555,7 +2555,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. @@ -2802,11 +2802,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`. }, @@ -2815,11 +2815,11 @@

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. }, - "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. @@ -2832,8 +2832,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index b24e91ccdd..af6526b26d 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -142,7 +142,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -152,11 +155,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. # Required. The content of the event. "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`. }, @@ -165,11 +168,11 @@

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. }, - "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. @@ -182,8 +185,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -490,7 +493,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -500,11 +506,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. # Required. The content of the event. "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`. }, @@ -513,11 +519,11 @@

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. }, - "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. @@ -530,8 +536,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -733,7 +739,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -743,11 +752,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. # Required. The content of the event. "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`. }, @@ -756,11 +765,11 @@

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. }, - "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. @@ -773,8 +782,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -981,7 +990,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -991,11 +1003,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. # Required. The content of the event. "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`. }, @@ -1004,11 +1016,11 @@

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. }, - "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. @@ -1021,8 +1033,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. diff --git a/docs/dyn/aiplatform_v1.v1.html b/docs/dyn/aiplatform_v1.v1.html index d0c7e8d854..74c3636d1c 100644 --- a/docs/dyn/aiplatform_v1.v1.html +++ b/docs/dyn/aiplatform_v1.v1.html @@ -777,11 +777,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`. }, @@ -790,11 +790,11 @@

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. }, - "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. @@ -807,8 +807,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -858,7 +858,7 @@

Method Details

"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. + "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. @@ -1086,11 +1086,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`. }, @@ -1099,11 +1099,11 @@

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. }, - "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. @@ -1116,8 +1116,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1167,7 +1167,7 @@

Method Details

"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. + "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. @@ -1391,11 +1391,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`. }, @@ -1404,11 +1404,11 @@

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. }, - "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. @@ -1421,8 +1421,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1471,11 +1471,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`. }, @@ -1484,11 +1484,11 @@

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. }, - "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. @@ -1501,8 +1501,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -1547,7 +1547,7 @@

Method Details

"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. + "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. @@ -1769,7 +1769,7 @@

Method Details

{ # 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. + "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. @@ -1987,11 +1987,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. # 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. + "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`. }, @@ -2000,11 +2000,11 @@

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. }, - "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. @@ -2017,8 +2017,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2069,7 +2069,7 @@

Method Details

}, ], }, - "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. + "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. `prompt`), the value of the field will take precedence over the value in other_data. "mapInstance": { # Optional. Map of instance data. "a_key": { # Instance data used to populate placeholders in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. @@ -2077,11 +2077,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`. }, @@ -2090,11 +2090,11 @@

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. }, - "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. @@ -2107,8 +2107,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2160,11 +2160,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`. }, @@ -2173,11 +2173,11 @@

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. }, - "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. @@ -2190,8 +2190,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2241,11 +2241,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`. }, @@ -2254,11 +2254,11 @@

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. }, - "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. @@ -2271,8 +2271,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2322,11 +2322,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`. }, @@ -2335,11 +2335,11 @@

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. }, - "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. @@ -2352,8 +2352,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2743,11 +2743,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`. }, @@ -2756,11 +2756,11 @@

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. }, - "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. @@ -2773,8 +2773,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -2865,11 +2865,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`. }, @@ -2878,11 +2878,11 @@

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. }, - "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. @@ -2895,8 +2895,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -3502,11 +3502,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`. }, @@ -3515,11 +3515,11 @@

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. }, - "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. @@ -3532,8 +3532,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. @@ -3583,7 +3583,7 @@

Method Details

"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. + "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. @@ -3804,11 +3804,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`. }, @@ -3817,11 +3817,11 @@

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. }, - "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. @@ -3834,8 +3834,8 @@

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. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "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. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index d0db801dab..0186be11f6 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -128,11 +128,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`. }, @@ -141,12 +141,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. @@ -159,9 +159,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. @@ -245,11 +245,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`. }, @@ -258,12 +258,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. @@ -276,9 +276,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. @@ -442,11 +442,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`. }, @@ -455,12 +455,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. @@ -473,9 +473,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. @@ -517,7 +517,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. @@ -817,11 +817,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`. }, @@ -830,12 +830,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. @@ -848,9 +848,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. @@ -1024,11 +1024,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`. }, @@ -1037,12 +1037,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. @@ -1055,9 +1055,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. @@ -1099,11 +1099,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. @@ -1115,7 +1115,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. @@ -1369,11 +1369,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`. }, @@ -1382,12 +1382,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. @@ -1400,9 +1400,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. @@ -1731,11 +1731,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`. }, @@ -1744,12 +1744,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. @@ -1762,9 +1762,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. @@ -1938,11 +1938,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`. }, @@ -1951,12 +1951,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. @@ -1969,9 +1969,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. @@ -2013,11 +2013,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. @@ -2029,7 +2029,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. @@ -2283,11 +2283,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`. }, @@ -2296,12 +2296,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. @@ -2314,9 +2314,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/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index bb0b01e94f..ef9e4259be 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -115,11 +115,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`. }, @@ -128,12 +128,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. @@ -146,9 +146,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. @@ -200,11 +200,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -213,12 +213,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. @@ -231,9 +231,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. @@ -275,11 +275,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -291,7 +291,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -536,11 +536,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`. }, @@ -549,12 +549,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. @@ -567,9 +567,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. @@ -621,11 +621,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -634,12 +634,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. @@ -652,9 +652,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. @@ -696,11 +696,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -712,7 +712,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -982,11 +982,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`. }, @@ -995,12 +995,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. @@ -1013,9 +1013,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. @@ -1067,11 +1067,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -1080,12 +1080,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. @@ -1098,9 +1098,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. @@ -1142,11 +1142,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -1158,7 +1158,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -1414,11 +1414,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`. }, @@ -1427,12 +1427,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. @@ -1445,9 +1445,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. @@ -1499,11 +1499,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -1512,12 +1512,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. @@ -1530,9 +1530,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. @@ -1574,11 +1574,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -1590,7 +1590,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -1854,11 +1854,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`. }, @@ -1867,12 +1867,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. @@ -1885,9 +1885,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. @@ -1939,11 +1939,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -1952,12 +1952,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. @@ -1970,9 +1970,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. @@ -2014,11 +2014,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -2030,7 +2030,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. @@ -2276,11 +2276,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`. }, @@ -2289,12 +2289,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. @@ -2307,9 +2307,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. @@ -2361,11 +2361,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. Input only. Immutable. Developer set system instruction. Currently, text only "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`. }, @@ -2374,12 +2374,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. @@ -2392,9 +2392,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. @@ -2436,11 +2436,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "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. @@ -2452,7 +2452,7 @@

Method Details

}, "tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response { # 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. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 9a9287c74b..22c755770a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -170,11 +170,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`. }, @@ -183,12 +183,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. @@ -201,9 +201,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. @@ -378,11 +378,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`. }, @@ -391,12 +391,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. @@ -409,9 +409,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. @@ -453,11 +453,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. @@ -469,7 +469,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. @@ -752,11 +752,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`. }, @@ -765,12 +765,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. @@ -783,9 +783,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. @@ -960,11 +960,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`. }, @@ -973,12 +973,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. @@ -991,9 +991,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. @@ -1035,11 +1035,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. @@ -1051,7 +1051,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. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 960dd04efc..b94ca052b4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -205,11 +205,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`. }, @@ -218,12 +218,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. @@ -236,9 +236,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. @@ -322,11 +322,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`. }, @@ -335,12 +335,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. @@ -353,9 +353,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. @@ -519,11 +519,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`. }, @@ -532,12 +532,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. @@ -550,9 +550,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. @@ -594,7 +594,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. @@ -1984,11 +1984,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`. }, @@ -1997,12 +1997,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. @@ -2015,9 +2015,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. @@ -2191,11 +2191,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`. }, @@ -2204,12 +2204,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. @@ -2222,9 +2222,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. @@ -2266,11 +2266,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. @@ -2282,7 +2282,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. @@ -2536,11 +2536,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`. }, @@ -2549,12 +2549,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. @@ -2567,9 +2567,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. @@ -4643,11 +4643,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`. }, @@ -4656,12 +4656,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. @@ -4674,9 +4674,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. @@ -4850,11 +4850,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`. }, @@ -4863,12 +4863,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. @@ -4881,9 +4881,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. @@ -4925,11 +4925,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. @@ -4941,7 +4941,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. @@ -5195,11 +5195,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`. }, @@ -5208,12 +5208,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. @@ -5226,9 +5226,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/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index d4d6cff1f9..dd7657d794 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -140,7 +140,7 @@

Method Details

], "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. + "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. @@ -369,7 +369,7 @@

Method Details

{ # 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. + "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. @@ -594,11 +594,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. # 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. + "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`. }, @@ -607,12 +607,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. @@ -625,9 +625,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. @@ -692,11 +692,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`. }, @@ -705,12 +705,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. @@ -723,9 +723,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. @@ -783,7 +783,7 @@

Method Details

], "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. + "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. @@ -1012,7 +1012,7 @@

Method Details

{ # 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. + "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. @@ -1237,11 +1237,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. # 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. + "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`. }, @@ -1250,12 +1250,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. @@ -1268,9 +1268,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. @@ -1335,11 +1335,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`. }, @@ -1348,12 +1348,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. @@ -1366,9 +1366,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. @@ -1425,7 +1425,7 @@

Method Details

], "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. + "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. @@ -1654,7 +1654,7 @@

Method Details

{ # 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. + "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. @@ -1879,11 +1879,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. # 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. + "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`. }, @@ -1892,12 +1892,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. @@ -1910,9 +1910,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. @@ -1968,11 +1968,11 @@

Method Details

"a_key": { # 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`. }, @@ -1981,12 +1981,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. @@ -1999,9 +1999,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. @@ -2110,7 +2110,7 @@

Method Details

], "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. + "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. @@ -2339,7 +2339,7 @@

Method Details

{ # 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. + "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. @@ -2564,11 +2564,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. # 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. + "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`. }, @@ -2577,12 +2577,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. @@ -2595,9 +2595,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. @@ -2662,11 +2662,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`. }, @@ -2675,12 +2675,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. @@ -2693,9 +2693,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. @@ -2753,7 +2753,7 @@

Method Details

], "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. + "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. @@ -2982,7 +2982,7 @@

Method Details

{ # 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. + "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. @@ -3207,11 +3207,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. # 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. + "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`. }, @@ -3220,12 +3220,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. @@ -3238,9 +3238,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. @@ -3305,11 +3305,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`. }, @@ -3318,12 +3318,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. @@ -3336,9 +3336,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. @@ -3395,7 +3395,7 @@

Method Details

], "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. + "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. @@ -3624,7 +3624,7 @@

Method Details

{ # 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. + "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. @@ -3849,11 +3849,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. # 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. + "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`. }, @@ -3862,12 +3862,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. @@ -3880,9 +3880,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. @@ -3938,11 +3938,11 @@

Method Details

"a_key": { # 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`. }, @@ -3951,12 +3951,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. @@ -3969,9 +3969,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. @@ -4080,7 +4080,7 @@

Method Details

], "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. + "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. @@ -4309,7 +4309,7 @@

Method Details

{ # 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. + "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. @@ -4534,11 +4534,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. # 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. + "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`. }, @@ -4547,12 +4547,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. @@ -4565,9 +4565,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. @@ -4632,11 +4632,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`. }, @@ -4645,12 +4645,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. @@ -4663,9 +4663,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. @@ -4723,7 +4723,7 @@

Method Details

], "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. + "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. @@ -4952,7 +4952,7 @@

Method Details

{ # 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. + "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. @@ -5177,11 +5177,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. # 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. + "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`. }, @@ -5190,12 +5190,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. @@ -5208,9 +5208,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. @@ -5275,11 +5275,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`. }, @@ -5288,12 +5288,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. @@ -5306,9 +5306,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. @@ -5365,7 +5365,7 @@

Method Details

], "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. + "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. @@ -5594,7 +5594,7 @@

Method Details

{ # 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. + "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. @@ -5819,11 +5819,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. # 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. + "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`. }, @@ -5832,12 +5832,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. @@ -5850,9 +5850,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. @@ -5908,11 +5908,11 @@

Method Details

"a_key": { # 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`. }, @@ -5921,12 +5921,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. @@ -5939,9 +5939,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. @@ -6050,7 +6050,7 @@

Method Details

], "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. + "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. @@ -6279,7 +6279,7 @@

Method Details

{ # 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. + "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. @@ -6504,11 +6504,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. # 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. + "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`. }, @@ -6517,12 +6517,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. @@ -6535,9 +6535,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. @@ -6602,11 +6602,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`. }, @@ -6615,12 +6615,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. @@ -6633,9 +6633,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. @@ -6693,7 +6693,7 @@

Method Details

], "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. + "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. @@ -6922,7 +6922,7 @@

Method Details

{ # 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. + "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. @@ -7147,11 +7147,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. # 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. + "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`. }, @@ -7160,12 +7160,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. @@ -7178,9 +7178,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. @@ -7245,11 +7245,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`. }, @@ -7258,12 +7258,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. @@ -7276,9 +7276,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. @@ -7335,7 +7335,7 @@

Method Details

], "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. + "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. @@ -7564,7 +7564,7 @@

Method Details

{ # 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. + "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. @@ -7789,11 +7789,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. # 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. + "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`. }, @@ -7802,12 +7802,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. @@ -7820,9 +7820,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. @@ -7878,11 +7878,11 @@

Method Details

"a_key": { # 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`. }, @@ -7891,12 +7891,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. @@ -7909,9 +7909,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. @@ -8062,7 +8062,7 @@

Method Details

], "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. + "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. @@ -8291,7 +8291,7 @@

Method Details

{ # 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. + "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. @@ -8516,11 +8516,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. # 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. + "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`. }, @@ -8529,12 +8529,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. @@ -8547,9 +8547,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. @@ -8614,11 +8614,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`. }, @@ -8627,12 +8627,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. @@ -8645,9 +8645,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. @@ -8705,7 +8705,7 @@

Method Details

], "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. + "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. @@ -8934,7 +8934,7 @@

Method Details

{ # 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. + "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. @@ -9159,11 +9159,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. # 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. + "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`. }, @@ -9172,12 +9172,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. @@ -9190,9 +9190,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. @@ -9257,11 +9257,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`. }, @@ -9270,12 +9270,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. @@ -9288,9 +9288,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. @@ -9347,7 +9347,7 @@

Method Details

], "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. + "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. @@ -9576,7 +9576,7 @@

Method Details

{ # 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. + "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. @@ -9801,11 +9801,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. # 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. + "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`. }, @@ -9814,12 +9814,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. @@ -9832,9 +9832,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. @@ -9890,11 +9890,11 @@

Method Details

"a_key": { # 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`. }, @@ -9903,12 +9903,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. @@ -9921,9 +9921,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. @@ -10032,7 +10032,7 @@

Method Details

], "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. + "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. @@ -10261,7 +10261,7 @@

Method Details

{ # 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. + "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. @@ -10486,11 +10486,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. # 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. + "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`. }, @@ -10499,12 +10499,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. @@ -10517,9 +10517,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. @@ -10584,11 +10584,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`. }, @@ -10597,12 +10597,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. @@ -10615,9 +10615,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. @@ -10675,7 +10675,7 @@

Method Details

], "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. + "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. @@ -10904,7 +10904,7 @@

Method Details

{ # 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. + "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. @@ -11129,11 +11129,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. # 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. + "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`. }, @@ -11142,12 +11142,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. @@ -11160,9 +11160,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. @@ -11227,11 +11227,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`. }, @@ -11240,12 +11240,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. @@ -11258,9 +11258,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. @@ -11317,7 +11317,7 @@

Method Details

], "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. + "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. @@ -11546,7 +11546,7 @@

Method Details

{ # 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. + "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. @@ -11771,11 +11771,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. # 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. + "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`. }, @@ -11784,12 +11784,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. @@ -11802,9 +11802,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. @@ -11860,11 +11860,11 @@

Method Details

"a_key": { # 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`. }, @@ -11873,12 +11873,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. @@ -11891,9 +11891,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. @@ -12015,7 +12015,7 @@

Method Details

], "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. + "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. @@ -12244,7 +12244,7 @@

Method Details

{ # 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. + "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. @@ -12469,11 +12469,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. # 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. + "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`. }, @@ -12482,12 +12482,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. @@ -12500,9 +12500,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. @@ -12567,11 +12567,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`. }, @@ -12580,12 +12580,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. @@ -12598,9 +12598,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. @@ -12658,7 +12658,7 @@

Method Details

], "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. + "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. @@ -12887,7 +12887,7 @@

Method Details

{ # 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. + "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. @@ -13112,11 +13112,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. # 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. + "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`. }, @@ -13125,12 +13125,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. @@ -13143,9 +13143,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. @@ -13210,11 +13210,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`. }, @@ -13223,12 +13223,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. @@ -13241,9 +13241,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. @@ -13300,7 +13300,7 @@

Method Details

], "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. + "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. @@ -13529,7 +13529,7 @@

Method Details

{ # 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. + "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. @@ -13754,11 +13754,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. # 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. + "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`. }, @@ -13767,12 +13767,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. @@ -13785,9 +13785,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. @@ -13843,11 +13843,11 @@

Method Details

"a_key": { # 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`. }, @@ -13856,12 +13856,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. @@ -13874,9 +13874,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. @@ -13985,7 +13985,7 @@

Method Details

], "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. + "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. @@ -14214,7 +14214,7 @@

Method Details

{ # 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. + "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. @@ -14439,11 +14439,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. # 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. + "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`. }, @@ -14452,12 +14452,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. @@ -14470,9 +14470,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. @@ -14537,11 +14537,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`. }, @@ -14550,12 +14550,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. @@ -14568,9 +14568,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. @@ -14628,7 +14628,7 @@

Method Details

], "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. + "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. @@ -14857,7 +14857,7 @@

Method Details

{ # 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. + "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. @@ -15082,11 +15082,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. # 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. + "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`. }, @@ -15095,12 +15095,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. @@ -15113,9 +15113,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. @@ -15180,11 +15180,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`. }, @@ -15193,12 +15193,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. @@ -15211,9 +15211,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. @@ -15270,7 +15270,7 @@

Method Details

], "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. + "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. @@ -15499,7 +15499,7 @@

Method Details

{ # 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. + "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. @@ -15724,11 +15724,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. # 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. + "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`. }, @@ -15737,12 +15737,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. @@ -15755,9 +15755,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. @@ -15813,11 +15813,11 @@

Method Details

"a_key": { # 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`. }, @@ -15826,12 +15826,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. @@ -15844,9 +15844,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/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 45095762ce..d73e3f7edb 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -289,6 +289,11 @@

Method Details

}, "sampleCount": 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. }, + "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. + { # Defines a custom dataset-level aggregation. + "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -1305,15 +1310,15 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "agentConfig": { # Configuration that describes an agent. # Optional. Agent config used to generate responses. + "agentConfig": { # Configuration that describes an agent. # Optional. Deprecated: Use `agents` instead. Agent config used to generate responses. "developerInstruction": { # 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 developer instruction for the agent. "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`. }, @@ -1322,12 +1327,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. @@ -1340,9 +1345,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. @@ -1384,7 +1389,7 @@

Method Details

}, "tools": [ # Optional. The tools available to the 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. + "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. @@ -1722,7 +1727,7 @@

Method Details

"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. }, - "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -1891,6 +1896,11 @@

Method Details

}, "sampleCount": 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. }, + "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. + { # Defines a custom dataset-level aggregation. + "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -2907,15 +2917,15 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "agentConfig": { # Configuration that describes an agent. # Optional. Agent config used to generate responses. + "agentConfig": { # Configuration that describes an agent. # Optional. Deprecated: Use `agents` instead. Agent config used to generate responses. "developerInstruction": { # 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 developer instruction for the agent. "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`. }, @@ -2924,12 +2934,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. @@ -2942,9 +2952,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. @@ -2986,7 +2996,7 @@

Method Details

}, "tools": [ # Optional. The tools available to the 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. + "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. @@ -3324,7 +3334,7 @@

Method Details

"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. }, - "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -3535,6 +3545,11 @@

Method Details

}, "sampleCount": 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. }, + "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. + { # Defines a custom dataset-level aggregation. + "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -4551,15 +4566,15 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "agentConfig": { # Configuration that describes an agent. # Optional. Agent config used to generate responses. + "agentConfig": { # Configuration that describes an agent. # Optional. Deprecated: Use `agents` instead. Agent config used to generate responses. "developerInstruction": { # 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 developer instruction for the agent. "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`. }, @@ -4568,12 +4583,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. @@ -4586,9 +4601,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. @@ -4630,7 +4645,7 @@

Method Details

}, "tools": [ # Optional. The tools available to the 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. + "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. @@ -4968,7 +4983,7 @@

Method Details

"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. }, - "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. @@ -5150,6 +5165,11 @@

Method Details

}, "sampleCount": 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. }, + "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. + { # Defines a custom dataset-level aggregation. + "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. + }, + ], "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -6166,15 +6186,15 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "agentConfig": { # Configuration that describes an agent. # Optional. Agent config used to generate responses. + "agentConfig": { # Configuration that describes an agent. # Optional. Deprecated: Use `agents` instead. Agent config used to generate responses. "developerInstruction": { # 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 developer instruction for the agent. "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`. }, @@ -6183,12 +6203,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. @@ -6201,9 +6221,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. @@ -6245,7 +6265,7 @@

Method Details

}, "tools": [ # Optional. The tools available to the 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. + "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. @@ -6583,7 +6603,7 @@

Method Details

"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. }, - "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, }, "labels": { # Optional. Labels for the evaluation run. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html index df848af1fe..07c7914252 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html @@ -245,11 +245,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`. }, @@ -258,12 +258,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. @@ -276,9 +276,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. @@ -324,11 +324,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. # Required. A single step's content. "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`. }, @@ -337,12 +337,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. @@ -355,9 +355,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. @@ -607,11 +607,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`. }, @@ -620,12 +620,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. @@ -638,9 +638,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. @@ -718,11 +718,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`. }, @@ -731,12 +731,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. @@ -749,9 +749,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. @@ -797,11 +797,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. # Required. A single step's content. "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`. }, @@ -810,12 +810,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. @@ -828,9 +828,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. @@ -907,11 +907,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`. }, @@ -920,12 +920,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. @@ -938,9 +938,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. @@ -986,11 +986,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. # Required. A single step's content. "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`. }, @@ -999,12 +999,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. @@ -1017,9 +1017,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. @@ -1094,11 +1094,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`. }, @@ -1107,12 +1107,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. @@ -1125,9 +1125,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. @@ -1173,11 +1173,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. # Required. A single step's content. "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`. }, @@ -1186,12 +1186,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. @@ -1204,9 +1204,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/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index d1eb498cd7..ae8fe58cd0 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -1148,11 +1148,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`. }, @@ -1161,12 +1161,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. @@ -1179,9 +1179,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. @@ -1238,11 +1238,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`. }, @@ -1251,12 +1251,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. @@ -1269,9 +1269,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/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 243a555e2c..282ffbc086 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -341,7 +341,7 @@

Instance Methods

Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.

generateSyntheticData(location, body=None, x__xgafv=None)

-

Generates synthetic data based on the provided configuration.

+

Generates synthetic (artificial) data based on a description

get(name, x__xgafv=None)

Gets information about a location.

@@ -402,7 +402,7 @@

Method Details

}, "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. + "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. @@ -695,7 +695,7 @@

Method Details

}, "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. + "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. @@ -961,11 +961,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`. }, @@ -974,12 +974,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. @@ -992,9 +992,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. @@ -1089,11 +1089,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`. }, @@ -1102,12 +1102,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. @@ -1120,9 +1120,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. @@ -1201,11 +1201,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. # Optional. Input content to corroborate, only text format is supported for now. "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`. }, @@ -1214,12 +1214,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. @@ -1232,9 +1232,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. @@ -2355,11 +2355,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`. }, @@ -2368,12 +2368,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. @@ -2386,9 +2386,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. @@ -2438,7 +2438,7 @@

Method Details

"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. + "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. @@ -2673,11 +2673,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`. }, @@ -2686,12 +2686,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. @@ -2704,9 +2704,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. @@ -2756,7 +2756,7 @@

Method Details

"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. + "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. @@ -2987,11 +2987,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`. }, @@ -3000,12 +3000,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. @@ -3018,9 +3018,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. @@ -3069,11 +3069,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`. }, @@ -3082,12 +3082,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. @@ -3100,9 +3100,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. @@ -3147,7 +3147,7 @@

Method Details

"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. + "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. @@ -3376,7 +3376,7 @@

Method Details

{ # 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. + "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. @@ -3601,11 +3601,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. # 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. + "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`. }, @@ -3614,12 +3614,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. @@ -3632,9 +3632,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. @@ -3697,7 +3697,7 @@

Method Details

], "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. + "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. @@ -3926,7 +3926,7 @@

Method Details

{ # 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. + "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. @@ -4151,11 +4151,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. # 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. + "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`. }, @@ -4164,12 +4164,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. @@ -4182,9 +4182,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. @@ -4235,7 +4235,7 @@

Method Details

}, ], }, - "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. + "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. `prompt`), the value of the field will take precedence over the value in other_data. "mapInstance": { # Optional. Map of instance data. "a_key": { # Instance data used to populate placeholders in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. @@ -4243,11 +4243,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`. }, @@ -4256,12 +4256,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. @@ -4274,9 +4274,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. @@ -4328,11 +4328,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`. }, @@ -4341,12 +4341,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. @@ -4359,9 +4359,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. @@ -4411,11 +4411,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`. }, @@ -4424,12 +4424,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. @@ -4442,9 +4442,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. @@ -4494,11 +4494,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`. }, @@ -4507,12 +4507,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. @@ -4525,9 +4525,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. @@ -4923,11 +4923,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`. }, @@ -4936,12 +4936,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. @@ -4954,9 +4954,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. @@ -5047,11 +5047,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`. }, @@ -5060,12 +5060,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. @@ -5078,9 +5078,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. @@ -5687,11 +5687,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`. }, @@ -5700,12 +5700,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. @@ -5718,9 +5718,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. @@ -5770,7 +5770,7 @@

Method Details

"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. + "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. @@ -5998,11 +5998,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`. }, @@ -6011,12 +6011,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. @@ -6029,9 +6029,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. @@ -6235,27 +6235,27 @@

Method Details

generateSyntheticData(location, body=None, x__xgafv=None) -
Generates synthetic data based on the provided configuration.
+  
Generates synthetic (artificial) data based on a description
 
 Args:
-  location: string, Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}` (required)
+  location: string, Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project}/locations/{location}`. For example, `projects/my-project/locations/us-central1`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for DataFoundryService.GenerateSyntheticData.
-  "count": 42, # Required. The number of synthetic examples to generate. For this stateless API, the count is limited to a small number.
-  "examples": [ # Optional. A list of few-shot examples to guide the model's output style and format.
-    { # Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response.
+{ # Request message for DataFoundryService.GenerateSyntheticData. It contains the settings and information needed to generate synthetic data.
+  "count": 42, # Required. The number of synthetic examples to generate. For this stateless API, you can generate up to 50 examples in a single request.
+  "examples": [ # Optional. A list of few-shot examples that help the model understand the desired style, tone, and format of the generated synthetic data. Providing these few-shot examples can significantly improve the quality and relevance of the output.
+    { # A single instance of generated synthetic data. Each example is made up of one or more named fields, as defined in `OutputFieldSpec`. These examples are used as few-shot examples to show the model what you want (in `GenerateSyntheticDataRequest.examples`) and to return generated examples in the response (in `GenerateSyntheticDataResponse.synthetic_examples`).
       "fields": [ # Required. A list of fields that constitute an example.
-        { # Represents a single named field within a SyntheticExample.
-          "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 field.
+        { # Represents a single named field within a synthetic example, consisting of a name and the actual content.
+          "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 actual content or value for this field. This can be text, images, or other types of data.
             "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`.
                 },
@@ -6264,12 +6264,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. @@ -6282,9 +6282,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. @@ -6324,20 +6324,20 @@

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'. }, - "fieldName": "A String", # Optional. The name of the field. + "fieldName": "A String", # Optional. The name of the specific field, such as "product_name" or "review_text". }, ], }, ], - "outputFieldSpecs": [ # Required. The schema of the desired output, defined by a list of fields. - { # Defines a specification for a single output field. - "fieldName": "A String", # Required. The name of the output field. + "outputFieldSpecs": [ # Required. Defines the schema of each synthetic example to be generated, defined by a list of fields. + { # Specifies the properties of a single field that are included in each generated synthetic example. This helps the model understand what kind of data to generate for each field. + "fieldName": "A String", # Required. The name of this field in the generated synthetic data, such as "email_subject" or "customer_review". "fieldType": "A String", # Optional. The data type of the field. Defaults to CONTENT if not set. - "guidance": "A String", # Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred. + "guidance": "A String", # Optional. Specific instructions for the large language model on how to generate content for this particular field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred. For example, for a field named "review", the guidance could be "A positive review about a coffee maker." }, ], - "taskDescription": { # Defines a generation strategy based on a high-level task description. # Generate data from a high-level task description. - "taskDescription": "A String", # Required. A high-level description of the synthetic data to be generated. + "taskDescription": { # Defines a generation strategy based on a general task description. # Generates synthetic data based on a high-level description of the task or data you want. + "taskDescription": "A String", # Required. A general description of the type of synthetic data you want to generate. For example, "Generate customer reviews for a new smartphone." }, } @@ -6349,19 +6349,19 @@

Method Details

Returns: An object of the form: - { # The response containing the generated data. - "syntheticExamples": [ # A list of generated synthetic examples. - { # Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response. + { # The response message for the `GenerateSyntheticData` method, containing the synthetic examples generated by the Gen AI evaluation service. + "syntheticExamples": [ # A list of generated synthetic examples, each containing a complete synthetic data instance generated based on your request. + { # A single instance of generated synthetic data. Each example is made up of one or more named fields, as defined in `OutputFieldSpec`. These examples are used as few-shot examples to show the model what you want (in `GenerateSyntheticDataRequest.examples`) and to return generated examples in the response (in `GenerateSyntheticDataResponse.synthetic_examples`). "fields": [ # Required. A list of fields that constitute an example. - { # Represents a single named field within a SyntheticExample. - "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 field. + { # Represents a single named field within a synthetic example, consisting of a name and the actual content. + "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 actual content or value for this field. This can be text, images, or other types of data. "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`. }, @@ -6370,12 +6370,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. @@ -6388,9 +6388,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. @@ -6430,7 +6430,7 @@

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'. }, - "fieldName": "A String", # Optional. The name of the field. + "fieldName": "A String", # Optional. The name of the specific field, such as "product_name" or "review_text". }, ], }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index a545d7029d..0a05ccb18e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -147,11 +147,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`. }, @@ -160,12 +160,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. @@ -178,9 +178,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. @@ -264,11 +264,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`. }, @@ -277,12 +277,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. @@ -295,9 +295,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. @@ -461,11 +461,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`. }, @@ -474,12 +474,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. @@ -492,9 +492,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. @@ -536,7 +536,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. @@ -793,11 +793,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. # 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. + "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`. }, @@ -806,12 +806,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. @@ -824,9 +824,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. @@ -866,6 +866,14 @@

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'. }, + "embedContentConfig": { # Configurations for the EmbedContent API. # Optional. Configuration for the EmbedContent request. + "audioTrackExtraction": True or False, # Optional. Whether to extract audio from video content. + "autoTruncate": True or False, # Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length. Only applicable to text-only embedding models. + "documentOcr": True or False, # Optional. Whether to enable OCR for document content. + "outputDimensionality": 42, # 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. Only applicable to text-only embedding models. + "title": "A String", # Optional. The title for the text. Only applicable to text-only embedding models. + }, "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. @@ -1052,11 +1060,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`. }, @@ -1065,12 +1073,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. @@ -1083,9 +1091,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. @@ -1259,11 +1267,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`. }, @@ -1272,12 +1280,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. @@ -1290,9 +1298,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. @@ -1334,11 +1342,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. @@ -1350,7 +1358,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. @@ -1604,11 +1612,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`. }, @@ -1617,12 +1625,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. @@ -1635,9 +1643,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. @@ -2282,11 +2290,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`. }, @@ -2295,12 +2303,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. @@ -2313,9 +2321,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. @@ -2489,11 +2497,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`. }, @@ -2502,12 +2510,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. @@ -2520,9 +2528,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. @@ -2564,11 +2572,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. @@ -2580,7 +2588,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. @@ -2834,11 +2842,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`. }, @@ -2847,12 +2855,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. @@ -2865,9 +2873,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/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index 5d0cc70454..ff96f53bcc 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -99,6 +99,11 @@

Instance Methods

Returns the operations Resource.

+

+ runtimeRevisions() +

+

Returns the runtimeRevisions Resource.

+

sandboxEnvironments()

@@ -167,7 +172,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -177,11 +185,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. # Required. The content of the event. "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`. }, @@ -190,12 +198,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. @@ -208,9 +216,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. @@ -520,7 +528,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -530,11 +541,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. # Required. The content of the event. "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`. }, @@ -543,12 +554,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. @@ -561,9 +572,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. @@ -804,7 +815,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -814,11 +828,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. # Required. The content of the event. "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`. }, @@ -827,12 +841,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. @@ -845,9 +859,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. @@ -1058,7 +1072,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -1068,11 +1085,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. # Required. The content of the event. "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`. }, @@ -1081,12 +1098,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. @@ -1099,9 +1116,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/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index a4e064ff55..702bbe1182 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -88,7 +88,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, x__xgafv=None)

+ create(parent, body=None, memoryId=None, x__xgafv=None)

Create a Memory.

delete(name, x__xgafv=None)

@@ -124,7 +124,7 @@

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, memoryId=None, x__xgafv=None)
Create a Memory.
 
 Args:
@@ -166,6 +166,7 @@ 

Method Details

"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. } + memoryId: string, Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -246,11 +247,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. # Required. A single piece of content from which to generate memories. "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`. }, @@ -259,12 +260,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. @@ -277,9 +278,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/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html new file mode 100644 index 0000000000..9c4a3bc0da --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.operations.html new file mode 100644 index 0000000000..c79b04fe94 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file 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 2c6a028a3a..921fd09d03 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -129,11 +129,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. # Optional. Content of the event provided by the author. "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`. }, @@ -142,12 +142,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. @@ -160,9 +160,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. @@ -318,6 +318,9 @@

Method Details

}, "invocationId": "A String", # Required. The invocation id of the event, multiple events can have the same invocation id. "name": "A String", # Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`. + "rawEvent": { # Optional. Weakly typed raw event data in proto struct format. + "a_key": "", # Properties of the object. + }, "timestamp": "A String", # Required. Timestamp when the event was created on client side. }, ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index c7bc9fb403..0fb21688fa 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -91,7 +91,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, x__xgafv=None)

+ create(parent, body=None, sessionId=None, x__xgafv=None)

Creates a new Session.

delete(name, x__xgafv=None)

@@ -137,11 +137,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. # Optional. Content of the event provided by the author. "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`. }, @@ -150,12 +150,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. @@ -168,9 +168,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. @@ -326,6 +326,9 @@

Method Details

}, "invocationId": "A String", # Required. The invocation id of the event, multiple events can have the same invocation id. "name": "A String", # Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`. + "rawEvent": { # Optional. Weakly typed raw event data in proto struct format. + "a_key": "", # Properties of the object. + }, "timestamp": "A String", # Required. Timestamp when the event was created on client side. } @@ -347,7 +350,7 @@

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a new Session.
 
 Args:
@@ -371,6 +374,7 @@ 

Method Details

"userId": "A String", # Required. Immutable. String id provided by the user } + sessionId: string, Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 350013204e..883518a5fb 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -894,11 +894,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`. }, @@ -907,12 +907,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. @@ -925,9 +925,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. @@ -1067,11 +1067,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -1080,12 +1080,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. @@ -1098,9 +1098,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. @@ -1147,11 +1147,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`. }, @@ -1160,12 +1160,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. @@ -1178,9 +1178,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. @@ -1273,11 +1273,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`. }, @@ -1286,12 +1286,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. @@ -1304,9 +1304,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. @@ -2178,11 +2178,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`. }, @@ -2191,12 +2191,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. @@ -2209,9 +2209,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. @@ -2351,11 +2351,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -2364,12 +2364,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. @@ -2382,9 +2382,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. @@ -2431,11 +2431,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`. }, @@ -2444,12 +2444,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. @@ -2462,9 +2462,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. @@ -2557,11 +2557,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`. }, @@ -2570,12 +2570,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. @@ -2588,9 +2588,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. @@ -3469,11 +3469,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`. }, @@ -3482,12 +3482,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. @@ -3500,9 +3500,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. @@ -3642,11 +3642,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -3655,12 +3655,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. @@ -3673,9 +3673,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. @@ -3722,11 +3722,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`. }, @@ -3735,12 +3735,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. @@ -3753,9 +3753,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. @@ -3848,11 +3848,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`. }, @@ -3861,12 +3861,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. @@ -3879,9 +3879,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. @@ -4766,11 +4766,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`. }, @@ -4779,12 +4779,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. @@ -4797,9 +4797,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. @@ -4939,11 +4939,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -4952,12 +4952,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. @@ -4970,9 +4970,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. @@ -5019,11 +5019,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`. }, @@ -5032,12 +5032,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. @@ -5050,9 +5050,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. @@ -5145,11 +5145,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`. }, @@ -5158,12 +5158,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. @@ -5176,9 +5176,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. @@ -5320,11 +5320,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. # Required. The content of the prompt to optimize. "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`. }, @@ -5333,12 +5333,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. @@ -5351,9 +5351,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. @@ -5408,11 +5408,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 optimized prompt. "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`. }, @@ -5421,12 +5421,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. @@ -5439,9 +5439,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. @@ -6255,11 +6255,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`. }, @@ -6268,12 +6268,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. @@ -6286,9 +6286,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. @@ -6428,11 +6428,11 @@

Method Details

"completion": { # 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. # Single turn completion for the given prompt. "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`. }, @@ -6441,12 +6441,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. @@ -6459,9 +6459,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. @@ -6508,11 +6508,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`. }, @@ -6521,12 +6521,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. @@ -6539,9 +6539,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. @@ -6634,11 +6634,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`. }, @@ -6647,12 +6647,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. @@ -6665,9 +6665,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/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index e8eb79e1fb..70c794b27e 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -127,11 +127,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`. }, @@ -140,12 +140,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. @@ -158,9 +158,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. @@ -244,11 +244,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`. }, @@ -257,12 +257,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. @@ -275,9 +275,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. @@ -441,11 +441,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`. }, @@ -454,12 +454,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. @@ -472,9 +472,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. @@ -516,7 +516,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. @@ -816,11 +816,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`. }, @@ -829,12 +829,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. @@ -847,9 +847,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. @@ -1023,11 +1023,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`. }, @@ -1036,12 +1036,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. @@ -1054,9 +1054,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. @@ -1098,11 +1098,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. @@ -1114,7 +1114,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. @@ -1368,11 +1368,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`. }, @@ -1381,12 +1381,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. @@ -1399,9 +1399,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. @@ -1660,7 +1660,7 @@

Method Details

"A String", ], "launchStage": "A String", # Optional. Indicates the launch stage of the model. - "name": "A String", # Output only. The resource name of the PublisherModel. + "name": "A String", # Output only. Identifier. The resource name of the PublisherModel. "openSourceCategory": "A String", # Required. Indicates the open source category of the publisher model. "parent": { # The information about the parent of a model. # Optional. The parent that this model was customized from. E.g., Vision API, Natural Language API, LaMDA, T5, etc. Foundation models don't have parents. "displayName": "A String", # Required. The display name of the parent. E.g., LaMDA, T5, Vision API, Natural Language API. @@ -2276,7 +2276,7 @@

Method Details

"A String", ], "launchStage": "A String", # Optional. Indicates the launch stage of the model. - "name": "A String", # Output only. The resource name of the PublisherModel. + "name": "A String", # Output only. Identifier. The resource name of the PublisherModel. "openSourceCategory": "A String", # Required. Indicates the open source category of the publisher model. "parent": { # The information about the parent of a model. # Optional. The parent that this model was customized from. E.g., Vision API, Natural Language API, LaMDA, T5, etc. Foundation models don't have parents. "displayName": "A String", # Required. The display name of the parent. E.g., LaMDA, T5, Vision API, Natural Language API. @@ -2973,11 +2973,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`. }, @@ -2986,12 +2986,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. @@ -3004,9 +3004,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. @@ -3180,11 +3180,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`. }, @@ -3193,12 +3193,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. @@ -3211,9 +3211,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. @@ -3255,11 +3255,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. @@ -3271,7 +3271,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. @@ -3525,11 +3525,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`. }, @@ -3538,12 +3538,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. @@ -3556,9 +3556,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/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index 8149d6bd62..ed616ef3e4 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -99,6 +99,11 @@

Instance Methods

Returns the operations Resource.

+

+ runtimeRevisions() +

+

Returns the runtimeRevisions Resource.

+

sandboxEnvironments()

@@ -157,7 +162,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -167,11 +175,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. # Required. The content of the event. "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`. }, @@ -180,12 +188,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. @@ -198,9 +206,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. @@ -511,7 +519,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -521,11 +532,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. # Required. The content of the event. "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`. }, @@ -534,12 +545,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. @@ -552,9 +563,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. @@ -760,7 +771,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -770,11 +784,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. # Required. The content of the event. "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`. }, @@ -783,12 +797,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. @@ -801,9 +815,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. @@ -1014,7 +1028,10 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Configuration for organizing memories for a particular scope. + { # Represents configuration for organizing memories for a particular scope. + "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. + "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + }, "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. @@ -1024,11 +1041,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. # Required. The content of the event. "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`. }, @@ -1037,12 +1054,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. @@ -1055,9 +1072,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/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index ce0003d760..319ab63307 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -88,7 +88,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, x__xgafv=None)

+ create(parent, body=None, memoryId=None, x__xgafv=None)

Create a Memory.

delete(name, x__xgafv=None)

@@ -124,7 +124,7 @@

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, memoryId=None, x__xgafv=None)
Create a Memory.
 
 Args:
@@ -166,6 +166,7 @@ 

Method Details

"updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. } + memoryId: string, Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -246,11 +247,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. # Required. A single piece of content from which to generate memories. "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`. }, @@ -259,12 +260,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. @@ -277,9 +278,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/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.html new file mode 100644 index 0000000000..2d404847da --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.operations.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.operations.html new file mode 100644 index 0000000000..b1c93b3255 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index 2189cfd24c..7dfa3d180f 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -129,11 +129,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. # Optional. Content of the event provided by the author. "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`. }, @@ -142,12 +142,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. @@ -160,9 +160,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. @@ -318,6 +318,9 @@

Method Details

}, "invocationId": "A String", # Required. The invocation id of the event, multiple events can have the same invocation id. "name": "A String", # Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`. + "rawEvent": { # Optional. Weakly typed raw event data in proto struct format. + "a_key": "", # Properties of the object. + }, "timestamp": "A String", # Required. Timestamp when the event was created on client side. }, ], diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index 1a6dc87639..e19afaf08a 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -91,7 +91,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, x__xgafv=None)

+ create(parent, body=None, sessionId=None, x__xgafv=None)

Creates a new Session.

delete(name, x__xgafv=None)

@@ -137,11 +137,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. # Optional. Content of the event provided by the author. "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`. }, @@ -150,12 +150,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. @@ -168,9 +168,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. @@ -326,6 +326,9 @@

Method Details

}, "invocationId": "A String", # Required. The invocation id of the event, multiple events can have the same invocation id. "name": "A String", # Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`. + "rawEvent": { # Optional. Weakly typed raw event data in proto struct format. + "a_key": "", # Properties of the object. + }, "timestamp": "A String", # Required. Timestamp when the event was created on client side. } @@ -347,7 +350,7 @@

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a new Session.
 
 Args:
@@ -371,6 +374,7 @@ 

Method Details

"userId": "A String", # Required. Immutable. String id provided by the user } + sessionId: string, Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index eb61fee5bf..65a9795d39 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -789,11 +789,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`. }, @@ -802,12 +802,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. @@ -820,9 +820,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. @@ -872,7 +872,7 @@

Method Details

"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. + "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. @@ -1107,11 +1107,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`. }, @@ -1120,12 +1120,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. @@ -1138,9 +1138,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. @@ -1190,7 +1190,7 @@

Method Details

"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. + "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. @@ -1421,11 +1421,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`. }, @@ -1434,12 +1434,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. @@ -1452,9 +1452,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. @@ -1503,11 +1503,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`. }, @@ -1516,12 +1516,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. @@ -1534,9 +1534,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. @@ -1581,7 +1581,7 @@

Method Details

"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. + "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. @@ -1810,7 +1810,7 @@

Method Details

{ # 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. + "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. @@ -2035,11 +2035,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. # 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. + "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`. }, @@ -2048,12 +2048,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. @@ -2066,9 +2066,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. @@ -2131,7 +2131,7 @@

Method Details

], "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. + "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. @@ -2360,7 +2360,7 @@

Method Details

{ # 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. + "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. @@ -2585,11 +2585,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. # 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. + "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`. }, @@ -2598,12 +2598,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. @@ -2616,9 +2616,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. @@ -2669,7 +2669,7 @@

Method Details

}, ], }, - "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. + "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. `prompt`), the value of the field will take precedence over the value in other_data. "mapInstance": { # Optional. Map of instance data. "a_key": { # Instance data used to populate placeholders in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. @@ -2677,11 +2677,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`. }, @@ -2690,12 +2690,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. @@ -2708,9 +2708,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. @@ -2762,11 +2762,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`. }, @@ -2775,12 +2775,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. @@ -2793,9 +2793,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. @@ -2845,11 +2845,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`. }, @@ -2858,12 +2858,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. @@ -2876,9 +2876,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. @@ -2928,11 +2928,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`. }, @@ -2941,12 +2941,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. @@ -2959,9 +2959,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. @@ -3357,11 +3357,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`. }, @@ -3370,12 +3370,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. @@ -3388,9 +3388,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. @@ -3481,11 +3481,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`. }, @@ -3494,12 +3494,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. @@ -3512,9 +3512,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. @@ -4120,11 +4120,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`. }, @@ -4133,12 +4133,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. @@ -4151,9 +4151,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. @@ -4203,7 +4203,7 @@

Method Details

"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. + "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. @@ -4431,11 +4431,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`. }, @@ -4444,12 +4444,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. @@ -4462,9 +4462,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/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 5789c86765..6943474ec1 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -6540,7 +6540,7 @@ ] }, "generateSyntheticData": { -"description": "Generates synthetic data based on the provided configuration.", +"description": "Generates synthetic (artificial) data based on a description", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", "httpMethod": "POST", "id": "aiplatform.projects.locations.generateSyntheticData", @@ -6549,7 +6549,7 @@ ], "parameters": { "location": { -"description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", +"description": "Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project}/locations/{location}`. For example, `projects/my-project/locations/us-central1`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -22530,6 +22530,11 @@ "parent" ], "parameters": { +"memoryId": { +"description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", +"location": "query", +"type": "string" +}, "parent": { "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", @@ -23485,6 +23490,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" +}, +"sessionId": { +"description": "Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", +"location": "query", +"type": "string" } }, "path": "v1/{+parent}/sessions", @@ -30855,7 +30865,7 @@ } } }, -"revision": "20260302", +"revision": "20260309", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -33501,7 +33511,7 @@ "type": "object" }, "GoogleCloudAiplatformV1CodeExecutionResult": { -"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": "GoogleCloudAiplatformV1CodeExecutionResult", "properties": { "outcome": { @@ -33514,9 +33524,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" }, @@ -35057,6 +35067,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1DatasetCustomMetric": { +"description": "Defines a custom dataset-level aggregation.", +"id": "GoogleCloudAiplatformV1DatasetCustomMetric", +"properties": { +"displayName": { +"description": "Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like \"dataset_custom_metric_1\", \"dataset_custom_metric_2\", etc., will be generated based on the order in the repeated field.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1DatasetDistribution": { "description": "Distribution computed over a tuning dataset.", "id": "GoogleCloudAiplatformV1DatasetDistribution", @@ -36133,6 +36154,10 @@ "$ref": "GoogleCloudAiplatformV1Content", "description": "Required. The content to be embedded." }, +"embedContentConfig": { +"$ref": "GoogleCloudAiplatformV1EmbedContentRequestEmbedContentConfig", +"description": "Optional. Configuration for the EmbedContent request." +}, "outputDimensionality": { "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.", @@ -36174,6 +36199,60 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EmbedContentRequestEmbedContentConfig": { +"description": "Configurations for the EmbedContent API.", +"id": "GoogleCloudAiplatformV1EmbedContentRequestEmbedContentConfig", +"properties": { +"audioTrackExtraction": { +"description": "Optional. Whether to extract audio from video content.", +"type": "boolean" +}, +"autoTruncate": { +"description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length. Only applicable to text-only embedding models.", +"type": "boolean" +}, +"documentOcr": { +"description": "Optional. Whether to enable OCR for document content.", +"type": "boolean" +}, +"outputDimensionality": { +"description": "Optional. 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. Only applicable to text-only embedding models.", +"enum": [ +"UNSPECIFIED", +"RETRIEVAL_QUERY", +"RETRIEVAL_DOCUMENT", +"SEMANTIC_SIMILARITY", +"CLASSIFICATION", +"CLUSTERING", +"QUESTION_ANSWERING", +"FACT_VERIFICATION", +"CODE_RETRIEVAL_QUERY" +], +"enumDescriptions": [ +"Unset value, which will default to one of the other enum values.", +"Specifies the given text is a query in a search/retrieval setting.", +"Specifies the given text is a document from the corpus being searched.", +"Specifies the given text will be used for STS.", +"Specifies that the given text will be classified.", +"Specifies that the embeddings will be used for clustering.", +"Specifies that the embeddings will be used for question answering.", +"Specifies that the embeddings will be used for fact verification.", +"Specifies that the embeddings will be used for code retrieval." +], +"type": "string" +}, +"title": { +"description": "Optional. The title for the text. Only applicable to text-only embedding models.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1EmbedContentResponse": { "description": "Response message for PredictionService.EmbedContent.", "id": "GoogleCloudAiplatformV1EmbedContentResponse", @@ -37020,7 +37099,7 @@ }, "otherData": { "$ref": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance", -"description": "Optional. Other data used to populate placeholders based on their key." +"description": "Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. `prompt`), the value of the field will take precedence over the value in other_data." }, "prompt": { "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", @@ -37582,6 +37661,13 @@ "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", "description": "Optional. The autorater config for the evaluation run." }, +"datasetCustomMetrics": { +"description": "Optional. Specifications for custom dataset-level aggregations.", +"items": { +"$ref": "GoogleCloudAiplatformV1DatasetCustomMetric" +}, +"type": "array" +}, "metrics": { "description": "Required. The metrics to be calculated in the evaluation run.", "items": { @@ -37666,7 +37752,7 @@ "description": "Optional. Generation config." }, "model": { -"description": "Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"description": "Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" } }, @@ -38227,7 +38313,7 @@ "type": "object" }, "GoogleCloudAiplatformV1ExecutableCode": { -"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": "GoogleCloudAiplatformV1ExecutableCode", "properties": { "code": { @@ -40876,7 +40962,7 @@ "type": "object" }, "GoogleCloudAiplatformV1FunctionCall": { -"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": "GoogleCloudAiplatformV1FunctionCall", "properties": { "args": { @@ -40884,11 +40970,11 @@ "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" }, "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": { @@ -40910,7 +40996,7 @@ "id": "GoogleCloudAiplatformV1FunctionCallingConfig", "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" }, @@ -40922,18 +41008,20 @@ "MODE_UNSPECIFIED", "AUTO", "ANY", -"NONE" +"NONE", +"VALIDATED" ], "enumDescriptions": [ "Unspecified function calling mode. This value should not be used.", "Default model behavior, model decides to predict either function calls or natural language response.", "Model is constrained to always predicting function calls only. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\".", -"Model will not predict any function calls. Model behavior is same as when not passing any function declarations." +"Model will not predict any function calls. Model behavior is same as when not passing any function declarations.", +"Model is constrained to predict either function calls or natural language response. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\"." ], "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" } }, @@ -40971,11 +41059,11 @@ "type": "object" }, "GoogleCloudAiplatformV1FunctionResponse": { -"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": "GoogleCloudAiplatformV1FunctionResponse", "properties": { "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": { @@ -41612,23 +41700,23 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerateSyntheticDataRequest": { -"description": "Request message for DataFoundryService.GenerateSyntheticData.", +"description": "Request message for DataFoundryService.GenerateSyntheticData. It contains the settings and information needed to generate synthetic data.", "id": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest", "properties": { "count": { -"description": "Required. The number of synthetic examples to generate. For this stateless API, the count is limited to a small number.", +"description": "Required. The number of synthetic examples to generate. For this stateless API, you can generate up to 50 examples in a single request.", "format": "int32", "type": "integer" }, "examples": { -"description": "Optional. A list of few-shot examples to guide the model's output style and format.", +"description": "Optional. A list of few-shot examples that help the model understand the desired style, tone, and format of the generated synthetic data. Providing these few-shot examples can significantly improve the quality and relevance of the output.", "items": { "$ref": "GoogleCloudAiplatformV1SyntheticExample" }, "type": "array" }, "outputFieldSpecs": { -"description": "Required. The schema of the desired output, defined by a list of fields.", +"description": "Required. Defines the schema of each synthetic example to be generated, defined by a list of fields.", "items": { "$ref": "GoogleCloudAiplatformV1OutputFieldSpec" }, @@ -41636,17 +41724,17 @@ }, "taskDescription": { "$ref": "GoogleCloudAiplatformV1TaskDescriptionStrategy", -"description": "Generate data from a high-level task description." +"description": "Generates synthetic data based on a high-level description of the task or data you want." } }, "type": "object" }, "GoogleCloudAiplatformV1GenerateSyntheticDataResponse": { -"description": "The response containing the generated data.", +"description": "The response message for the `GenerateSyntheticData` method, containing the synthetic examples generated by the Gen AI evaluation service.", "id": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse", "properties": { "syntheticExamples": { -"description": "A list of generated synthetic examples.", +"description": "A list of generated synthetic examples, each containing a complete synthetic data instance generated based on your request.", "items": { "$ref": "GoogleCloudAiplatformV1SyntheticExample" }, @@ -44922,9 +45010,13 @@ false "type": "object" }, "GoogleCloudAiplatformV1MemoryBankCustomizationConfig": { -"description": "Configuration for organizing memories for a particular scope.", +"description": "Represents configuration for organizing memories for a particular scope.", "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfig", "properties": { +"consolidationConfig": { +"$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigConsolidationConfig", +"description": "Optional. Represents configuration for customizing how memories are consolidated together." +}, "enableThirdPersonMemories": { "description": "Optional. If true, then the memories will be generated in the third person (i.e. \"The user generates memories with Memory Bank.\"). By default, the memories will be generated in the first person (i.e. \"I generate memories with Memory Bank.\")", "type": "boolean" @@ -44953,6 +45045,18 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1MemoryBankCustomizationConfigConsolidationConfig": { +"description": "Represents configuration for customizing how memories are consolidated.", +"id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigConsolidationConfig", +"properties": { +"revisionsPerCandidateCount": { +"description": "Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExample": { "description": "An example of how to generate memories for a particular scope.", "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExample", @@ -48409,11 +48513,11 @@ false "type": "object" }, "GoogleCloudAiplatformV1OutputFieldSpec": { -"description": "Defines a specification for a single output field.", +"description": "Specifies the properties of a single field that are included in each generated synthetic example. This helps the model understand what kind of data to generate for each field.", "id": "GoogleCloudAiplatformV1OutputFieldSpec", "properties": { "fieldName": { -"description": "Required. The name of the output field.", +"description": "Required. The name of this field in the generated synthetic data, such as \"email_subject\" or \"customer_review\".", "type": "string" }, "fieldType": { @@ -48426,16 +48530,16 @@ false "AUDIO" ], "enumDescriptions": [ -"Field type is unspecified.", -"Arbitrary content field type.", -"Text field type.", -"Image field type.", -"Audio field type." +"The field type is not specified. Defaults to CONTENT.", +"The field can contain any type of content, including text, images, and audio.", +"The field contains only text.", +"The field contains image data.", +"The field contains audio data." ], "type": "string" }, "guidance": { -"description": "Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.", +"description": "Optional. Specific instructions for the large language model on how to generate content for this particular field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred. For example, for a field named \"review\", the guidance could be \"A positive review about a coffee maker.\"", "type": "string" } }, @@ -50241,7 +50345,7 @@ false "type": "string" }, "name": { -"description": "Output only. The resource name of the PublisherModel.", +"description": "Output only. Identifier. The resource name of the PublisherModel.", "readOnly": true, "type": "string" }, @@ -58595,6 +58699,14 @@ false "description": "Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.", "type": "string" }, +"rawEvent": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Weakly typed raw event data in proto struct format.", +"type": "object" +}, "timestamp": { "description": "Required. Timestamp when the event was created on client side.", "format": "google-datetime", @@ -60128,7 +60240,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1SyntheticExample": { -"description": "Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response.", +"description": "A single instance of generated synthetic data. Each example is made up of one or more named fields, as defined in `OutputFieldSpec`. These examples are used as few-shot examples to show the model what you want (in `GenerateSyntheticDataRequest.examples`) and to return generated examples in the response (in `GenerateSyntheticDataResponse.synthetic_examples`).", "id": "GoogleCloudAiplatformV1SyntheticExample", "properties": { "fields": { @@ -60142,15 +60254,15 @@ false "type": "object" }, "GoogleCloudAiplatformV1SyntheticField": { -"description": "Represents a single named field within a SyntheticExample.", +"description": "Represents a single named field within a synthetic example, consisting of a name and the actual content.", "id": "GoogleCloudAiplatformV1SyntheticField", "properties": { "content": { "$ref": "GoogleCloudAiplatformV1Content", -"description": "Required. The content of the field." +"description": "Required. The actual content or value for this field. This can be text, images, or other types of data." }, "fieldName": { -"description": "Optional. The name of the field.", +"description": "Optional. The name of the specific field, such as \"product_name\" or \"review_text\".", "type": "string" } }, @@ -60168,11 +60280,11 @@ false "type": "object" }, "GoogleCloudAiplatformV1TaskDescriptionStrategy": { -"description": "Defines a generation strategy based on a high-level task description.", +"description": "Defines a generation strategy based on a general task description.", "id": "GoogleCloudAiplatformV1TaskDescriptionStrategy", "properties": { "taskDescription": { -"description": "Required. A high-level description of the synthetic data to be generated.", +"description": "Required. A general description of the type of synthetic data you want to generate. For example, \"Generate customer reviews for a new smartphone.\"", "type": "string" } }, @@ -60879,7 +60991,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1ToolCodeExecution": { -"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": "GoogleCloudAiplatformV1ToolCodeExecution", "properties": {}, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 63681ae63c..087b972b08 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -8522,7 +8522,7 @@ ] }, "generateSyntheticData": { -"description": "Generates synthetic data based on the provided configuration.", +"description": "Generates synthetic (artificial) data based on a description", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", "httpMethod": "POST", "id": "aiplatform.projects.locations.generateSyntheticData", @@ -8531,7 +8531,7 @@ ], "parameters": { "location": { -"description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", +"description": "Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project}/locations/{location}`. For example, `projects/my-project/locations/us-central1`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -29055,6 +29055,11 @@ "parent" ], "parameters": { +"memoryId": { +"description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", +"location": "query", +"type": "string" +}, "parent": { "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", @@ -29702,6 +29707,166 @@ } } }, +"runtimeRevisions": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "sandboxEnvironments": { "methods": { "create": { @@ -30056,6 +30221,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" +}, +"sessionId": { +"description": "Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", +"location": "query", +"type": "string" } }, "path": "v1beta1/{+parent}/sessions", @@ -35914,6 +36084,11 @@ "parent" ], "parameters": { +"memoryId": { +"description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", +"location": "query", +"type": "string" +}, "parent": { "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", @@ -36561,6 +36736,166 @@ } } }, +"runtimeRevisions": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "sandboxEnvironments": { "methods": { "create": { @@ -36915,6 +37250,11 @@ "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" +}, +"sessionId": { +"description": "Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", +"location": "query", +"type": "string" } }, "path": "v1beta1/{+parent}/sessions", @@ -38906,7 +39246,7 @@ } } }, -"revision": "20260302", +"revision": "20260309", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -41913,7 +42253,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": { @@ -41926,9 +42266,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" }, @@ -43614,6 +43954,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1DatasetCustomMetric": { +"description": "Defines a custom dataset-level aggregation.", +"id": "GoogleCloudAiplatformV1beta1DatasetCustomMetric", +"properties": { +"displayName": { +"description": "Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like \"dataset_custom_metric_1\", \"dataset_custom_metric_2\", etc., will be generated based on the order in the repeated field.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1DatasetDistribution": { "description": "Distribution computed over a tuning dataset.", "id": "GoogleCloudAiplatformV1beta1DatasetDistribution", @@ -44920,6 +45271,10 @@ "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "Required. The content to be embedded." }, +"embedContentConfig": { +"$ref": "GoogleCloudAiplatformV1beta1EmbedContentRequestEmbedContentConfig", +"description": "Optional. Configuration for the EmbedContent request." +}, "outputDimensionality": { "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.", @@ -44961,6 +45316,60 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1EmbedContentRequestEmbedContentConfig": { +"description": "Configurations for the EmbedContent API.", +"id": "GoogleCloudAiplatformV1beta1EmbedContentRequestEmbedContentConfig", +"properties": { +"audioTrackExtraction": { +"description": "Optional. Whether to extract audio from video content.", +"type": "boolean" +}, +"autoTruncate": { +"description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length. Only applicable to text-only embedding models.", +"type": "boolean" +}, +"documentOcr": { +"description": "Optional. Whether to enable OCR for document content.", +"type": "boolean" +}, +"outputDimensionality": { +"description": "Optional. 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. Only applicable to text-only embedding models.", +"enum": [ +"UNSPECIFIED", +"RETRIEVAL_QUERY", +"RETRIEVAL_DOCUMENT", +"SEMANTIC_SIMILARITY", +"CLASSIFICATION", +"CLUSTERING", +"QUESTION_ANSWERING", +"FACT_VERIFICATION", +"CODE_RETRIEVAL_QUERY" +], +"enumDescriptions": [ +"Unset value, which will default to one of the other enum values.", +"Specifies the given text is a query in a search/retrieval setting.", +"Specifies the given text is a document from the corpus being searched.", +"Specifies the given text will be used for STS.", +"Specifies that the given text will be classified.", +"Specifies that the embeddings will be used for clustering.", +"Specifies that the embeddings will be used for question answering.", +"Specifies that the embeddings will be used for fact verification.", +"Specifies that the embeddings will be used for code retrieval." +], +"type": "string" +}, +"title": { +"description": "Optional. The title for the text. Only applicable to text-only embedding models.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1EmbedContentResponse": { "description": "Response message for PredictionService.EmbedContent.", "id": "GoogleCloudAiplatformV1beta1EmbedContentResponse", @@ -45850,7 +46259,7 @@ }, "otherData": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance", -"description": "Optional. Other data used to populate placeholders based on their key." +"description": "Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. `prompt`), the value of the field will take precedence over the value in other_data." }, "prompt": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", @@ -46416,6 +46825,13 @@ "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", "description": "Optional. The autorater config for the evaluation run." }, +"datasetCustomMetrics": { +"description": "Optional. Specifications for custom dataset-level aggregations.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1DatasetCustomMetric" +}, +"type": "array" +}, "metrics": { "description": "Required. The metrics to be calculated in the evaluation run.", "items": { @@ -46497,14 +46913,15 @@ "properties": { "agentConfig": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigInferenceAgentConfig", -"description": "Optional. Agent config used to generate responses." +"deprecated": true, +"description": "Optional. Deprecated: Use `agents` instead. Agent config used to generate responses." }, "generationConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", "description": "Optional. Generation config." }, "model": { -"description": "Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"description": "Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model format: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" } }, @@ -47185,7 +47602,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": { @@ -50492,7 +50909,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": { @@ -50500,7 +50917,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": { @@ -50508,7 +50925,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": { @@ -50530,7 +50947,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" }, @@ -50555,7 +50972,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" } }, @@ -50593,7 +51010,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": { @@ -50601,7 +51018,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": { @@ -51365,23 +51782,23 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest": { -"description": "Request message for DataFoundryService.GenerateSyntheticData.", +"description": "Request message for DataFoundryService.GenerateSyntheticData. It contains the settings and information needed to generate synthetic data.", "id": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest", "properties": { "count": { -"description": "Required. The number of synthetic examples to generate. For this stateless API, the count is limited to a small number.", +"description": "Required. The number of synthetic examples to generate. For this stateless API, you can generate up to 50 examples in a single request.", "format": "int32", "type": "integer" }, "examples": { -"description": "Optional. A list of few-shot examples to guide the model's output style and format.", +"description": "Optional. A list of few-shot examples that help the model understand the desired style, tone, and format of the generated synthetic data. Providing these few-shot examples can significantly improve the quality and relevance of the output.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SyntheticExample" }, "type": "array" }, "outputFieldSpecs": { -"description": "Required. The schema of the desired output, defined by a list of fields.", +"description": "Required. Defines the schema of each synthetic example to be generated, defined by a list of fields.", "items": { "$ref": "GoogleCloudAiplatformV1beta1OutputFieldSpec" }, @@ -51389,17 +51806,17 @@ }, "taskDescription": { "$ref": "GoogleCloudAiplatformV1beta1TaskDescriptionStrategy", -"description": "Generate data from a high-level task description." +"description": "Generates synthetic data based on a high-level description of the task or data you want." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse": { -"description": "The response containing the generated data.", +"description": "The response message for the `GenerateSyntheticData` method, containing the synthetic examples generated by the Gen AI evaluation service.", "id": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse", "properties": { "syntheticExamples": { -"description": "A list of generated synthetic examples.", +"description": "A list of generated synthetic examples, each containing a complete synthetic data instance generated based on your request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SyntheticExample" }, @@ -55093,9 +55510,13 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig": { -"description": "Configuration for organizing memories for a particular scope.", +"description": "Represents configuration for organizing memories for a particular scope.", "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig", "properties": { +"consolidationConfig": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigConsolidationConfig", +"description": "Optional. Represents configuration for customizing how memories are consolidated together." +}, "enableThirdPersonMemories": { "description": "Optional. If true, then the memories will be generated in the third person (i.e. \"The user generates memories with Memory Bank.\"). By default, the memories will be generated in the first person (i.e. \"I generate memories with Memory Bank.\")", "type": "boolean" @@ -55124,6 +55545,18 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigConsolidationConfig": { +"description": "Represents configuration for customizing how memories are consolidated.", +"id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigConsolidationConfig", +"properties": { +"revisionsPerCandidateCount": { +"description": "Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExample": { "description": "An example of how to generate memories for a particular scope.", "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExample", @@ -59439,11 +59872,11 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1OutputFieldSpec": { -"description": "Defines a specification for a single output field.", +"description": "Specifies the properties of a single field that are included in each generated synthetic example. This helps the model understand what kind of data to generate for each field.", "id": "GoogleCloudAiplatformV1beta1OutputFieldSpec", "properties": { "fieldName": { -"description": "Required. The name of the output field.", +"description": "Required. The name of this field in the generated synthetic data, such as \"email_subject\" or \"customer_review\".", "type": "string" }, "fieldType": { @@ -59456,16 +59889,16 @@ false "AUDIO" ], "enumDescriptions": [ -"Field type is unspecified.", -"Arbitrary content field type.", -"Text field type.", -"Image field type.", -"Audio field type." +"The field type is not specified. Defaults to CONTENT.", +"The field can contain any type of content, including text, images, and audio.", +"The field contains only text.", +"The field contains image data.", +"The field contains audio data." ], "type": "string" }, "guidance": { -"description": "Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.", +"description": "Optional. Specific instructions for the large language model on how to generate content for this particular field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred. For example, for a field named \"review\", the guidance could be \"A positive review about a coffee maker.\"", "type": "string" } }, @@ -61458,7 +61891,7 @@ false "type": "string" }, "name": { -"description": "Output only. The resource name of the PublisherModel.", +"description": "Output only. Identifier. The resource name of the PublisherModel.", "readOnly": true, "type": "string" }, @@ -70921,6 +71354,14 @@ false "description": "Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.", "type": "string" }, +"rawEvent": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Weakly typed raw event data in proto struct format.", +"type": "object" +}, "timestamp": { "description": "Required. Timestamp when the event was created on client side.", "format": "google-datetime", @@ -72689,7 +73130,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1SyntheticExample": { -"description": "Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response.", +"description": "A single instance of generated synthetic data. Each example is made up of one or more named fields, as defined in `OutputFieldSpec`. These examples are used as few-shot examples to show the model what you want (in `GenerateSyntheticDataRequest.examples`) and to return generated examples in the response (in `GenerateSyntheticDataResponse.synthetic_examples`).", "id": "GoogleCloudAiplatformV1beta1SyntheticExample", "properties": { "fields": { @@ -72703,15 +73144,15 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1SyntheticField": { -"description": "Represents a single named field within a SyntheticExample.", +"description": "Represents a single named field within a synthetic example, consisting of a name and the actual content.", "id": "GoogleCloudAiplatformV1beta1SyntheticField", "properties": { "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", -"description": "Required. The content of the field." +"description": "Required. The actual content or value for this field. This can be text, images, or other types of data." }, "fieldName": { -"description": "Optional. The name of the field.", +"description": "Optional. The name of the specific field, such as \"product_name\" or \"review_text\".", "type": "string" } }, @@ -72729,11 +73170,11 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1TaskDescriptionStrategy": { -"description": "Defines a generation strategy based on a high-level task description.", +"description": "Defines a generation strategy based on a general task description.", "id": "GoogleCloudAiplatformV1beta1TaskDescriptionStrategy", "properties": { "taskDescription": { -"description": "Required. A high-level description of the synthetic data to be generated.", +"description": "Required. A general description of the type of synthetic data you want to generate. For example, \"Generate customer reviews for a new smartphone.\"", "type": "string" } }, @@ -73440,7 +73881,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 0ae6b5ef1979366181fa6c2518767769c45be897 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:43 +0000 Subject: [PATCH 04/31] feat(analyticshub): update the api #### analyticshub:v1 The following keys were added: - schemas.BigtableConfig (Total Keys: 6) - schemas.GooglePubsubV1Subscription.properties.bigtableConfig.$ref (Total Keys: 1) --- ...ects.locations.dataExchanges.listings.html | 6 ++++ .../documents/analyticshub.v1.json | 29 ++++++++++++++++++- 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html index ac5626746e..6e6633e91e 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html @@ -927,6 +927,12 @@

Method Details

"useTopicSchema": True or False, # Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be enabled at the same time. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. }, + "bigtableConfig": { # Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows: - row key: subscription name and message ID delimited by #. - columns: message bytes written to a single column family "data" with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. + "appProfileId": "A String", # Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing. + "serviceAccountEmail": "A String", # Optional. The service account to use to write to Bigtable. The subscription 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. + "table": "A String", # Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`. + "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table under the pubsub_metadata column family. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. + }, "cloudStorageConfig": { # Configuration for a Cloud Storage subscription. # Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. "avroConfig": { # Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary. # Optional. If set, message data will be written to Cloud Storage in Avro format. "useTopicSchema": True or False, # Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists. diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index dbe0f53ed1..ac21949b3a 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1247,7 +1247,7 @@ } } }, -"revision": "20260118", +"revision": "20260308", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AIInference": { @@ -1406,6 +1406,29 @@ }, "type": "object" }, +"BigtableConfig": { +"description": "Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows: - row key: subscription name and message ID delimited by #. - columns: message bytes written to a single column family \"data\" with an empty-string column qualifier. - cell timestamp: the message publish timestamp.", +"id": "BigtableConfig", +"properties": { +"appProfileId": { +"description": "Optional. The app profile to use for the Bigtable writes. If not specified, the \"default\" application profile will be used. The app profile must use single-cluster routing.", +"type": "string" +}, +"serviceAccountEmail": { +"description": "Optional. The service account to use to write to Bigtable. The subscription 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.", +"type": "string" +}, +"table": { +"description": "Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`.", +"type": "string" +}, +"writeMetadata": { +"description": "Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table under the pubsub_metadata column family. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.", +"type": "boolean" +} +}, +"type": "object" +}, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -1794,6 +1817,10 @@ "$ref": "BigQueryConfig", "description": "Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it." }, +"bigtableConfig": { +"$ref": "BigtableConfig", +"description": "Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it." +}, "cloudStorageConfig": { "$ref": "CloudStorageConfig", "description": "Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it." From 3bcae30e9a5b4ab190b71118301ba987f57b39c7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:43 +0000 Subject: [PATCH 05/31] feat(androidpublisher): update the api #### androidpublisher:v3 The following keys were added: - resources.applications.resources.tracks.resources.releases.methods.list (Total Keys: 11) - resources.edits.methods.commit.parameters.changesInReviewBehavior (Total Keys: 2) - schemas.ArtifactSummary (Total Keys: 4) - schemas.ListReleaseSummariesResponse (Total Keys: 4) - schemas.ReleaseSummary (Total Keys: 7) --- .../dyn/androidpublisher_v3.applications.html | 5 + ...droidpublisher_v3.applications.tracks.html | 91 +++++++++++++ ...isher_v3.applications.tracks.releases.html | 119 +++++++++++++++++ docs/dyn/androidpublisher_v3.edits.html | 9 +- .../documents/androidpublisher.v3.json | 120 +++++++++++++++++- 5 files changed, 341 insertions(+), 3 deletions(-) create mode 100644 docs/dyn/androidpublisher_v3.applications.tracks.html create mode 100644 docs/dyn/androidpublisher_v3.applications.tracks.releases.html diff --git a/docs/dyn/androidpublisher_v3.applications.html b/docs/dyn/androidpublisher_v3.applications.html index e92f80aec9..c5cde32ec2 100644 --- a/docs/dyn/androidpublisher_v3.applications.html +++ b/docs/dyn/androidpublisher_v3.applications.html @@ -79,6 +79,11 @@

Instance Methods

Returns the deviceTierConfigs Resource.

+

+ tracks() +

+

Returns the tracks Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/androidpublisher_v3.applications.tracks.html b/docs/dyn/androidpublisher_v3.applications.tracks.html new file mode 100644 index 0000000000..b44d06c02f --- /dev/null +++ b/docs/dyn/androidpublisher_v3.applications.tracks.html @@ -0,0 +1,91 @@ + + + +

Google Play Android Developer API . applications . tracks

+

Instance Methods

+

+ releases() +

+

Returns the releases Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.applications.tracks.releases.html b/docs/dyn/androidpublisher_v3.applications.tracks.releases.html new file mode 100644 index 0000000000..28f1f01cd0 --- /dev/null +++ b/docs/dyn/androidpublisher_v3.applications.tracks.releases.html @@ -0,0 +1,119 @@ + + + +

Google Play Android Developer API . applications . tracks . releases

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, x__xgafv=None)

+

Returns the list of all releases for a given track. This excludes any releases that are obsolete.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, x__xgafv=None) +
Returns the list of all releases for a given track. This excludes any releases that are obsolete.
+
+Args:
+  parent: string, Required. The parent track, which owns this collection of releases. Format: applications/{package_name}/tracks/{track} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response listing all releases for a given track that are either ready to be sent for review, in review, approved, not approved or available.
+  "releases": [ # List of releases for this track. There will be a maximum of 20 releases returned.
+    { # Summary of a release.
+      "activeArtifacts": [ # List of active artifacts on this release.
+        { # Summary of an artifact.
+          "versionCode": 42, # The version code of the artifact.
+        },
+      ],
+      "releaseLifecycleState": "A String", # The lifecycle state of a release.
+      "releaseName": "A String", # Name of the release.
+      "track": "A String", # Identifier of the track. More on [track name](https://developers.google.com/android-publisher/tracks).
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.edits.html b/docs/dyn/androidpublisher_v3.edits.html index 4938779d16..8abbaf4c1b 100644 --- a/docs/dyn/androidpublisher_v3.edits.html +++ b/docs/dyn/androidpublisher_v3.edits.html @@ -128,7 +128,7 @@

Instance Methods

close()

Close httplib2 connections.

- commit(packageName, editId, changesNotSentForReview=None, x__xgafv=None)

+ commit(packageName, editId, changesInReviewBehavior=None, changesNotSentForReview=None, x__xgafv=None)

Commits an app edit.

delete(packageName, editId, x__xgafv=None)

@@ -149,12 +149,17 @@

Method Details

- commit(packageName, editId, changesNotSentForReview=None, x__xgafv=None) + commit(packageName, editId, changesInReviewBehavior=None, changesNotSentForReview=None, x__xgafv=None)
Commits an app edit.
 
 Args:
   packageName: string, Package name of the app. (required)
   editId: string, Identifier of the edit. (required)
+  changesInReviewBehavior: string, Optional. Specify how the API should behave if there are changes currently in review. If this value is not set, it will default to "CANCEL_IN_REVIEW_AND_SUBMIT", which will cancel the changes in review and then send all the changes for publishing.
+    Allowed values
+      CHANGES_IN_REVIEW_BEHAVIOR_TYPE_UNSPECIFIED - Defaults to CANCEL_IN_REVIEW_AND_SUBMIT.
+      CANCEL_IN_REVIEW_AND_SUBMIT - If there are changes already in review, then this will cancel that review first and then send all the changes for publishing.
+      ERROR_IF_IN_REVIEW - If there are changes in review, then this will return an error. Please refer to the error message sample that is returned when this happens. Note that this won't invalidate the edit. If there aren't any changes in review, then this will continue and send the new changes for publishing.
   changesNotSentForReview: boolean, When a rejection happens, the parameter will make sure that the changes in this edit won't be reviewed until they are explicitly sent for review from within the Google Play Console UI. These changes will be added to any other changes that are not yet sent for review.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json
index a6f0c5fa2a..4466e5f6ea 100644
--- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json
+++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json
@@ -237,6 +237,39 @@
 ]
 }
 }
+},
+"tracks": {
+"resources": {
+"releases": {
+"methods": {
+"list": {
+"description": "Returns the list of all releases for a given track. This excludes any releases that are obsolete.",
+"flatPath": "androidpublisher/v3/applications/{applicationsId}/tracks/{tracksId}/releases",
+"httpMethod": "GET",
+"id": "androidpublisher.applications.tracks.releases.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent track, which owns this collection of releases. Format: applications/{package_name}/tracks/{track}",
+"location": "path",
+"pattern": "^applications/[^/]+/tracks/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "androidpublisher/v3/{+parent}/releases",
+"response": {
+"$ref": "ListReleaseSummariesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/androidpublisher"
+]
+}
+}
+}
+}
 }
 }
 },
@@ -418,6 +451,21 @@
 "editId"
 ],
 "parameters": {
+"changesInReviewBehavior": {
+"description": "Optional. Specify how the API should behave if there are changes currently in review. If this value is not set, it will default to \"CANCEL_IN_REVIEW_AND_SUBMIT\", which will cancel the changes in review and then send all the changes for publishing.",
+"enum": [
+"CHANGES_IN_REVIEW_BEHAVIOR_TYPE_UNSPECIFIED",
+"CANCEL_IN_REVIEW_AND_SUBMIT",
+"ERROR_IF_IN_REVIEW"
+],
+"enumDescriptions": [
+"Defaults to CANCEL_IN_REVIEW_AND_SUBMIT.",
+"If there are changes already in review, then this will cancel that review first and then send all the changes for publishing.",
+"If there are changes in review, then this will return an error. Please refer to the error message sample that is returned when this happens. Note that this won't invalidate the edit. If there aren't any changes in review, then this will continue and send the new changes for publishing."
+],
+"location": "query",
+"type": "string"
+},
 "changesNotSentForReview": {
 "description": "When a rejection happens, the parameter will make sure that the changes in this edit won't be reviewed until they are explicitly sent for review from within the Google Play Console UI. These changes will be added to any other changes that are not yet sent for review.",
 "location": "query",
@@ -5589,7 +5637,7 @@
 }
 }
 },
-"revision": "20260204",
+"revision": "20260312",
 "rootUrl": "https://androidpublisher.googleapis.com/",
 "schemas": {
 "Abi": {
@@ -6126,6 +6174,18 @@
 "properties": {},
 "type": "object"
 },
+"ArtifactSummary": {
+"description": "Summary of an artifact.",
+"id": "ArtifactSummary",
+"properties": {
+"versionCode": {
+"description": "The version code of the artifact.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "AssetModuleMetadata": {
 "description": "Metadata of an asset module.",
 "id": "AssetModuleMetadata",
@@ -8967,6 +9027,20 @@ false
 },
 "type": "object"
 },
+"ListReleaseSummariesResponse": {
+"description": "Response listing all releases for a given track that are either ready to be sent for review, in review, approved, not approved or available.",
+"id": "ListReleaseSummariesResponse",
+"properties": {
+"releases": {
+"description": "List of releases for this track. There will be a maximum of 20 releases returned.",
+"items": {
+"$ref": "ReleaseSummary"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "ListSubscriptionOffersResponse": {
 "description": "Response message for ListSubscriptionOffers.",
 "id": "ListSubscriptionOffersResponse",
@@ -10993,6 +11067,50 @@ false
 },
 "type": "object"
 },
+"ReleaseSummary": {
+"description": "Summary of a release.",
+"id": "ReleaseSummary",
+"properties": {
+"activeArtifacts": {
+"description": "List of active artifacts on this release.",
+"items": {
+"$ref": "ArtifactSummary"
+},
+"type": "array"
+},
+"releaseLifecycleState": {
+"description": "The lifecycle state of a release.",
+"enum": [
+"RELEASE_LIFECYCLE_STATE_UNSPECIFIED",
+"RELEASE_LIFECYCLE_STATE_DRAFT",
+"RELEASE_LIFECYCLE_STATE_NOT_SENT_FOR_REVIEW",
+"RELEASE_LIFECYCLE_STATE_IN_REVIEW",
+"RELEASE_LIFECYCLE_STATE_APPROVED_NOT_PUBLISHED",
+"RELEASE_LIFECYCLE_STATE_NOT_APPROVED",
+"RELEASE_LIFECYCLE_STATE_PUBLISHED"
+],
+"enumDescriptions": [
+"Not specified.",
+"The release is not yet ready and can be still edited.",
+"The release is ready to be sent for review and awaiting developer action.",
+"Submitted and undergoing the review process.",
+"Passed review and is ready to be published (due to managed publishing).",
+"Failed the review process.",
+"Currently available to users on the track. This includes fully or partially rolled out releases to users and any halted release that can be resumed."
+],
+"type": "string"
+},
+"releaseName": {
+"description": "Name of the release.",
+"type": "string"
+},
+"track": {
+"description": "Identifier of the track. More on [track name](https://developers.google.com/android-publisher/tracks).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "RemoteInAppUpdate": {
 "description": "Object representation for Remote in-app update action type.",
 "id": "RemoteInAppUpdate",

From d5853837b735d4094892f84433d95bd11b451fa8 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 17 Mar 2026 07:29:43 +0000
Subject: [PATCH 06/31] feat(apihub): update the api

#### apihub:v1

The following keys were deleted:
- schemas.GoogleCloudApihubV1ApiView.properties.mcpServerView.readOnly (Total Keys: 1)
- schemas.GoogleCloudApihubV1ApiView.properties.mcpToolView.readOnly (Total Keys: 1)

The following keys were added:
- resources.projects.resources.locations.resources.apiHubInstances.methods.patch (Total Keys: 15)
- schemas.GoogleCloudApihubV1AgentRegistrySyncConfig (Total Keys: 3)
- schemas.GoogleCloudApihubV1Config.properties.agentRegistrySyncConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudApihubV1RetrieveApiViewsResponse.properties.apiViews.readOnly (Total Keys: 1)
---
 ...v1.projects.locations.apiHubInstances.html | 72 ++++++++++++++++++
 docs/dyn/apihub_v1.projects.locations.html    | 20 ++---
 .../discovery_cache/documents/apihub.v1.json  | 74 +++++++++++++++----
 3 files changed, 143 insertions(+), 23 deletions(-)

diff --git a/docs/dyn/apihub_v1.projects.locations.apiHubInstances.html b/docs/dyn/apihub_v1.projects.locations.apiHubInstances.html
index 316bc9cd0b..e605717694 100644
--- a/docs/dyn/apihub_v1.projects.locations.apiHubInstances.html
+++ b/docs/dyn/apihub_v1.projects.locations.apiHubInstances.html
@@ -89,6 +89,9 @@ 

Instance Methods

lookup(parent, x__xgafv=None)

Looks up an Api Hub instance in a given Google Cloud project. There will always be only one Api Hub instance for a Google Cloud project across all locations.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Update an Api Hub instance. The following fields in the ApiHubInstance can be updated: * disable_search * vertex_location * agent_registry_sync_config The update_mask should be used to specify the fields being updated.

Method Details

close() @@ -106,6 +109,9 @@

Method Details

{ # An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project. "config": { # Available configurations to provision an ApiHub Instance. # Required. Config of the ApiHub instance. + "agentRegistrySyncConfig": { # The configuration for Agent Registry sync. # Optional. The configuration for syncing MCP data in the API Hub instance to the Agent Registry. + "disabled": True or False, # Optional. If true, the MCP data sync to the Agent Registry will be disabled. The default value is false. + }, "cmekKeyName": "A String", # Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance. "disableSearch": True or False, # Optional. If true, the search will be disabled for the instance. The default value is false. "encryptionType": "A String", # Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used. @@ -203,6 +209,9 @@

Method Details

{ # An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project. "config": { # Available configurations to provision an ApiHub Instance. # Required. Config of the ApiHub instance. + "agentRegistrySyncConfig": { # The configuration for Agent Registry sync. # Optional. The configuration for syncing MCP data in the API Hub instance to the Agent Registry. + "disabled": True or False, # Optional. If true, the MCP data sync to the Agent Registry will be disabled. The default value is false. + }, "cmekKeyName": "A String", # Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance. "disableSearch": True or False, # Optional. If true, the search will be disabled for the instance. The default value is false. "encryptionType": "A String", # Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used. @@ -237,6 +246,9 @@

Method Details

{ # The LookupApiHubInstance method's response.` "apiHubInstance": { # An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project. # API Hub instance for a project if it exists, empty otherwise. "config": { # Available configurations to provision an ApiHub Instance. # Required. Config of the ApiHub instance. + "agentRegistrySyncConfig": { # The configuration for Agent Registry sync. # Optional. The configuration for syncing MCP data in the API Hub instance to the Agent Registry. + "disabled": True or False, # Optional. If true, the MCP data sync to the Agent Registry will be disabled. The default value is false. + }, "cmekKeyName": "A String", # Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance. "disableSearch": True or False, # Optional. If true, the search will be disabled for the instance. The default value is false. "encryptionType": "A String", # Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used. @@ -255,4 +267,64 @@

Method Details

}
+
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update an Api Hub instance. The following fields in the ApiHubInstance can be updated: * disable_search * vertex_location * agent_registry_sync_config The update_mask should be used to specify the fields being updated.
+
+Args:
+  name: string, Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.
+  "config": { # Available configurations to provision an ApiHub Instance. # Required. Config of the ApiHub instance.
+    "agentRegistrySyncConfig": { # The configuration for Agent Registry sync. # Optional. The configuration for syncing MCP data in the API Hub instance to the Agent Registry.
+      "disabled": True or False, # Optional. If true, the MCP data sync to the Agent Registry will be disabled. The default value is false.
+    },
+    "cmekKeyName": "A String", # Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.
+    "disableSearch": True or False, # Optional. If true, the search will be disabled for the instance. The default value is false.
+    "encryptionType": "A String", # Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used.
+    "vertexLocation": "A String", # Optional. The name of the Vertex AI location where the data store is stored.
+  },
+  "createTime": "A String", # Output only. Creation timestamp.
+  "description": "A String", # Optional. Description of the ApiHub instance.
+  "labels": { # Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
+  "state": "A String", # Output only. The current state of the ApiHub instance.
+  "stateMessage": "A String", # Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`.
+  "updateTime": "A String", # Output only. Last update timestamp.
+}
+
+  updateMask: string, Optional. The list of 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:
+
+    { # 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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/apihub_v1.projects.locations.html b/docs/dyn/apihub_v1.projects.locations.html index edbbdac8d8..624a9465cc 100644 --- a/docs/dyn/apihub_v1.projects.locations.html +++ b/docs/dyn/apihub_v1.projects.locations.html @@ -1151,10 +1151,10 @@

Method Details

An object of the form: { # The RetrieveApiViews method's response. - "apiViews": [ # The list of API views. + "apiViews": [ # Output only. The list of API views. { # The view of an API. - "mcpServerView": { # A flattened view of an API, its version and one of the linked deployments. # Output only. MCP server view. - "api": { # An API resource in the API Hub. # The API. + "mcpServerView": { # A flattened view of an API, its version and one of the linked deployments. # MCP server view. + "api": { # An API resource in the API Hub. # Optional. The API. "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -1439,7 +1439,7 @@

Method Details

"A String", ], }, - "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # The deployment. + "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # Optional. The deployment. "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -1640,7 +1640,7 @@

Method Details

}, "updateTime": "A String", # Output only. The time at which the deployment was last updated. }, - "version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # The version. + "version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # Optional. The version. "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -1790,8 +1790,8 @@

Method Details

"updateTime": "A String", # Output only. The time at which the version was last updated. }, }, - "mcpToolView": { # A flattened view of an API, its version, one of its operations and one of the linked deployments. If there are no deployments linked to the operation then the result will be empty. # Output only. MCP tools view. - "api": { # An API resource in the API Hub. # The API. + "mcpToolView": { # A flattened view of an API, its version, one of its operations and one of the linked deployments. If there are no deployments linked to the operation then the result will be empty. # MCP tools view. + "api": { # An API resource in the API Hub. # Optional. The API. "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -2076,7 +2076,7 @@

Method Details

"A String", ], }, - "apiOperation": { # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API. # The API operation. + "apiOperation": { # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API. # Optional. The API operation. "attributes": { # Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. "a_key": { # The attribute values associated with resource. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} @@ -2163,7 +2163,7 @@

Method Details

"spec": "A String", # Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API. "updateTime": "A String", # Output only. The time at which the operation was last updated. }, - "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # The deployment. + "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # Optional. The deployment. "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -2364,7 +2364,7 @@

Method Details

}, "updateTime": "A String", # Output only. The time at which the deployment was last updated. }, - "version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # The version. + "version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # Optional. The version. "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. diff --git a/googleapiclient/discovery_cache/documents/apihub.v1.json b/googleapiclient/discovery_cache/documents/apihub.v1.json index 92a5aba71a..c5a7028c9f 100644 --- a/googleapiclient/discovery_cache/documents/apihub.v1.json +++ b/googleapiclient/discovery_cache/documents/apihub.v1.json @@ -574,6 +574,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Update an Api Hub instance. The following fields in the ApiHubInstance can be updated: * disable_search * vertex_location * agent_registry_sync_config The update_mask should be used to specify the fields being updated.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances/{apiHubInstancesId}", +"httpMethod": "PATCH", +"id": "apihub.projects.locations.apiHubInstances.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apiHubInstances/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudApihubV1ApiHubInstance" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -3220,7 +3254,7 @@ } } }, -"revision": "20260211", +"revision": "20260311", "rootUrl": "https://apihub.googleapis.com/", "schemas": { "Empty": { @@ -3399,6 +3433,17 @@ }, "type": "object" }, +"GoogleCloudApihubV1AgentRegistrySyncConfig": { +"description": "The configuration for Agent Registry sync.", +"id": "GoogleCloudApihubV1AgentRegistrySyncConfig", +"properties": { +"disabled": { +"description": "Optional. If true, the MCP data sync to the Agent Registry will be disabled. The default value is false.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudApihubV1AllDataAddonConfig": { "description": "Configuration for addons which act on all data in the API hub. This is used to specify if the addon is enabled for all data in the API hub.", "id": "GoogleCloudApihubV1AllDataAddonConfig", @@ -3745,13 +3790,11 @@ "properties": { "mcpServerView": { "$ref": "GoogleCloudApihubV1FlattenedApiVersionDeploymentView", -"description": "Output only. MCP server view.", -"readOnly": true +"description": "MCP server view." }, "mcpToolView": { "$ref": "GoogleCloudApihubV1FlattenedApiVersionOperationDeploymentView", -"description": "Output only. MCP tools view.", -"readOnly": true +"description": "MCP tools view." } }, "type": "object" @@ -4055,6 +4098,10 @@ "description": "Available configurations to provision an ApiHub Instance.", "id": "GoogleCloudApihubV1Config", "properties": { +"agentRegistrySyncConfig": { +"$ref": "GoogleCloudApihubV1AgentRegistrySyncConfig", +"description": "Optional. The configuration for syncing MCP data in the API Hub instance to the Agent Registry." +}, "cmekKeyName": { "description": "Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.", "type": "string" @@ -5013,15 +5060,15 @@ "properties": { "api": { "$ref": "GoogleCloudApihubV1Api", -"description": "The API." +"description": "Optional. The API." }, "deployment": { "$ref": "GoogleCloudApihubV1Deployment", -"description": "The deployment." +"description": "Optional. The deployment." }, "version": { "$ref": "GoogleCloudApihubV1Version", -"description": "The version." +"description": "Optional. The version." } }, "type": "object" @@ -5032,19 +5079,19 @@ "properties": { "api": { "$ref": "GoogleCloudApihubV1Api", -"description": "The API." +"description": "Optional. The API." }, "apiOperation": { "$ref": "GoogleCloudApihubV1ApiOperation", -"description": "The API operation." +"description": "Optional. The API operation." }, "deployment": { "$ref": "GoogleCloudApihubV1Deployment", -"description": "The deployment." +"description": "Optional. The deployment." }, "version": { "$ref": "GoogleCloudApihubV1Version", -"description": "The version." +"description": "Optional. The version." } }, "type": "object" @@ -6513,10 +6560,11 @@ "id": "GoogleCloudApihubV1RetrieveApiViewsResponse", "properties": { "apiViews": { -"description": "The list of API views.", +"description": "Output only. The list of API views.", "items": { "$ref": "GoogleCloudApihubV1ApiView" }, +"readOnly": true, "type": "array" }, "nextPageToken": { From df7e53eccd94a3772b9cfc091971d7b8d01b94e9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:44 +0000 Subject: [PATCH 07/31] feat(backupdr): update the api #### backupdr:v1 The following keys were added: - schemas.BackupPlan.properties.diskBackupPlanProperties.$ref (Total Keys: 1) - schemas.DiskBackupPlanProperties (Total Keys: 3) - schemas.DiskBackupProperties.properties.guestFlush.type (Total Keys: 1) --- ...pdr_v1.projects.locations.backupPlans.html | 12 ++++++++++ ...jects.locations.backupPlans.revisions.html | 6 +++++ ...ions.backupVaults.dataSources.backups.html | 4 ++++ .../documents/backupdr.v1.json | 22 ++++++++++++++++++- 4 files changed, 43 insertions(+), 1 deletion(-) diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html index d830df2751..f52d9d84fe 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html @@ -148,6 +148,9 @@

Method Details

"backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. + "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources. "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. "a_key": "A String", @@ -279,6 +282,9 @@

Method Details

"backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. + "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources. "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. "a_key": "A String", @@ -350,6 +356,9 @@

Method Details

"backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. + "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources. "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. "a_key": "A String", @@ -430,6 +439,9 @@

Method Details

"backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. + "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources. "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. "a_key": "A String", diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html index 2e47d0658b..06583876c1 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html @@ -140,6 +140,9 @@

Method Details

"backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. + "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources. "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. "a_key": "A String", @@ -215,6 +218,9 @@

Method Details

"backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. "createTime": "A String", # Output only. When the `BackupPlan` was created. "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. + "diskBackupPlanProperties": { # --- DiskBackupPlanProperties Message --- # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush. + "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false. + }, "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources. "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. "a_key": "A String", diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html index c14dfa1f61..28202a6ab2 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -357,6 +357,7 @@

Method Details

"architecture": "A String", # The architecture of the source disk. Valid values are ARM64 or X86_64. "description": "A String", # A description of the source disk. "enableConfidentialCompute": True or False, # Indicates whether the source disk is using confidential compute mode. + "guestFlush": True or False, # Optional. Defines if the guest flush is enabled for the source disk. Default value is false. "guestOsFeature": [ # A list of guest OS features that are applicable to this backup. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -650,6 +651,7 @@

Method Details

"architecture": "A String", # The architecture of the source disk. Valid values are ARM64 or X86_64. "description": "A String", # A description of the source disk. "enableConfidentialCompute": True or False, # Indicates whether the source disk is using confidential compute mode. + "guestFlush": True or False, # Optional. Defines if the guest flush is enabled for the source disk. Default value is false. "guestOsFeature": [ # A list of guest OS features that are applicable to this backup. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -932,6 +934,7 @@

Method Details

"architecture": "A String", # The architecture of the source disk. Valid values are ARM64 or X86_64. "description": "A String", # A description of the source disk. "enableConfidentialCompute": True or False, # Indicates whether the source disk is using confidential compute mode. + "guestFlush": True or False, # Optional. Defines if the guest flush is enabled for the source disk. Default value is false. "guestOsFeature": [ # A list of guest OS features that are applicable to this backup. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -1218,6 +1221,7 @@

Method Details

"architecture": "A String", # The architecture of the source disk. Valid values are ARM64 or X86_64. "description": "A String", # A description of the source disk. "enableConfidentialCompute": True or False, # Indicates whether the source disk is using confidential compute mode. + "guestFlush": True or False, # Optional. Defines if the guest flush is enabled for the source disk. Default value is false. "guestOsFeature": [ # A list of guest OS features that are applicable to this backup. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 929ed80b09..2b4f4227f9 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -2262,7 +2262,7 @@ } } }, -"revision": "20260227", +"revision": "20260309", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -3279,6 +3279,10 @@ "description": "Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: \"This is a backup plan that performs a daily backup at 6pm and retains data for 3 months\". The description must be at most 2048 characters.", "type": "string" }, +"diskBackupPlanProperties": { +"$ref": "DiskBackupPlanProperties", +"description": "Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush." +}, "etag": { "description": "Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.", "type": "string" @@ -4441,6 +4445,17 @@ }, "type": "object" }, +"DiskBackupPlanProperties": { +"description": "--- DiskBackupPlanProperties Message ---", +"id": "DiskBackupPlanProperties", +"properties": { +"guestFlush": { +"description": "Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false.", +"type": "boolean" +} +}, +"type": "object" +}, "DiskBackupProperties": { "description": "DiskBackupProperties represents the properties of a Disk backup.", "id": "DiskBackupProperties", @@ -4471,6 +4486,10 @@ "description": "Indicates whether the source disk is using confidential compute mode.", "type": "boolean" }, +"guestFlush": { +"description": "Optional. Defines if the guest flush is enabled for the source disk. Default value is false.", +"type": "boolean" +}, "guestOsFeature": { "description": "A list of guest OS features that are applicable to this backup.", "items": { @@ -5536,6 +5555,7 @@ "id": "LocationMetadata", "properties": { "unsupportedFeatures": { +"description": "List of features that are not supported in the location.", "items": { "enum": [ "FEATURE_UNSPECIFIED", From a2ecc21536965effba0c9190c43f01f29eb8588f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:44 +0000 Subject: [PATCH 08/31] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - schemas.DmlStatistics.properties.dmlMode (Total Keys: 2) - schemas.DmlStatistics.properties.fineGrainedDmlUnusedReason (Total Keys: 2) - schemas.JobStatistics2.properties.referencedPropertyGraphs (Total Keys: 3) - schemas.PropertyGraphReference (Total Keys: 5) --- docs/dyn/bigquery_v2.jobs.html | 47 ++++++++++++++ .../documents/bigquery.v2.json | 61 ++++++++++++++++++- 2 files changed, 107 insertions(+), 1 deletion(-) diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 85eb943146..88b8315ba5 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -705,6 +705,8 @@

Method Details

}, "dmlStats": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. "deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. + "dmlMode": "A String", # Output only. DML mode used. + "fineGrainedDmlUnusedReason": "A String", # Output only. Reason for disabling fine-grained DML if applicable. "insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements "updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements. }, @@ -1363,6 +1365,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. + { # Id path of a property graph. + "datasetId": "A String", # Required. The ID of the dataset containing this property graph. + "projectId": "A String", # Required. The ID of the project containing this property graph. + "propertyGraphId": "A String", # Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + }, + ], "referencedRoutines": [ # Output only. Referenced routines for the job. { # Id path of a routine. "datasetId": "A String", # Required. The ID of the dataset containing this routine. @@ -2231,6 +2240,8 @@

Method Details

}, "dmlStats": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. "deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. + "dmlMode": "A String", # Output only. DML mode used. + "fineGrainedDmlUnusedReason": "A String", # Output only. Reason for disabling fine-grained DML if applicable. "insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements "updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements. }, @@ -2889,6 +2900,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. + { # Id path of a property graph. + "datasetId": "A String", # Required. The ID of the dataset containing this property graph. + "projectId": "A String", # Required. The ID of the project containing this property graph. + "propertyGraphId": "A String", # Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + }, + ], "referencedRoutines": [ # Output only. Referenced routines for the job. { # Id path of a routine. "datasetId": "A String", # Required. The ID of the dataset containing this routine. @@ -3845,6 +3863,8 @@

Method Details

}, "dmlStats": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. "deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. + "dmlMode": "A String", # Output only. DML mode used. + "fineGrainedDmlUnusedReason": "A String", # Output only. Reason for disabling fine-grained DML if applicable. "insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements "updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements. }, @@ -4503,6 +4523,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. + { # Id path of a property graph. + "datasetId": "A String", # Required. The ID of the dataset containing this property graph. + "projectId": "A String", # Required. The ID of the project containing this property graph. + "propertyGraphId": "A String", # Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + }, + ], "referencedRoutines": [ # Output only. Referenced routines for the job. { # Id path of a routine. "datasetId": "A String", # Required. The ID of the dataset containing this routine. @@ -5342,6 +5369,8 @@

Method Details

}, "dmlStats": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. "deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. + "dmlMode": "A String", # Output only. DML mode used. + "fineGrainedDmlUnusedReason": "A String", # Output only. Reason for disabling fine-grained DML if applicable. "insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements "updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements. }, @@ -6000,6 +6029,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. + { # Id path of a property graph. + "datasetId": "A String", # Required. The ID of the dataset containing this property graph. + "projectId": "A String", # Required. The ID of the project containing this property graph. + "propertyGraphId": "A String", # Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + }, + ], "referencedRoutines": [ # Output only. Referenced routines for the job. { # Id path of a routine. "datasetId": "A String", # Required. The ID of the dataset containing this routine. @@ -6864,6 +6900,8 @@

Method Details

}, "dmlStats": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. "deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. + "dmlMode": "A String", # Output only. DML mode used. + "fineGrainedDmlUnusedReason": "A String", # Output only. Reason for disabling fine-grained DML if applicable. "insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements "updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements. }, @@ -7522,6 +7560,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. + { # Id path of a property graph. + "datasetId": "A String", # Required. The ID of the dataset containing this property graph. + "projectId": "A String", # Required. The ID of the project containing this property graph. + "propertyGraphId": "A String", # Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. + }, + ], "referencedRoutines": [ # Output only. Referenced routines for the job. { # Id path of a routine. "datasetId": "A String", # Required. The ID of the dataset containing this routine. @@ -7885,6 +7930,8 @@

Method Details

"creationTime": "A String", # Output only. Creation time of this query, in milliseconds since the epoch. This field will be present on all queries. "dmlStats": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. "deletedRowCount": "A String", # Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. + "dmlMode": "A String", # Output only. DML mode used. + "fineGrainedDmlUnusedReason": "A String", # Output only. Reason for disabling fine-grained DML if applicable. "insertedRowCount": "A String", # Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements "updatedRowCount": "A String", # Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements. }, diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 7f512ff72e..987d1f0d3e 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -2390,7 +2390,7 @@ } } }, -"revision": "20260211", +"revision": "20260224", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -4080,6 +4080,38 @@ "readOnly": true, "type": "string" }, +"dmlMode": { +"description": "Output only. DML mode used.", +"enum": [ +"DML_MODE_UNSPECIFIED", +"COARSE_GRAINED_DML", +"FINE_GRAINED_DML" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Coarse-grained DML was used.", +"Fine-grained DML was used." +], +"readOnly": true, +"type": "string" +}, +"fineGrainedDmlUnusedReason": { +"description": "Output only. Reason for disabling fine-grained DML if applicable.", +"enum": [ +"FINE_GRAINED_DML_UNUSED_REASON_UNSPECIFIED", +"MAX_PARTITION_SIZE_EXCEEDED", +"TABLE_NOT_ENROLLED", +"DML_IN_MULTI_STATEMENT_TRANSACTION" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Max partition size threshold exceeded. [Fine-grained DML Limitations] (https://docs.cloud.google.com/bigquery/docs/data-manipulation-language#fine-grained-dml-limitations)", +"The table is not enrolled for fine-grained DML.", +"The DML statement is part of a multi-statement transaction." +], +"readOnly": true, +"type": "string" +}, "insertedRowCount": { "description": "Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements", "format": "int64", @@ -6563,6 +6595,14 @@ "readOnly": true, "type": "array" }, +"referencedPropertyGraphs": { +"description": "Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list.", +"items": { +"$ref": "PropertyGraphReference" +}, +"readOnly": true, +"type": "array" +}, "referencedRoutines": { "description": "Output only. Referenced routines for the job.", "items": { @@ -7744,6 +7784,25 @@ }, "type": "object" }, +"PropertyGraphReference": { +"description": "Id path of a property graph.", +"id": "PropertyGraphReference", +"properties": { +"datasetId": { +"description": "Required. The ID of the dataset containing this property graph.", +"type": "string" +}, +"projectId": { +"description": "Required. The ID of the project containing this property graph.", +"type": "string" +}, +"propertyGraphId": { +"description": "Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.", +"type": "string" +} +}, +"type": "object" +}, "PruningStats": { "description": "The column metadata index pruning statistics.", "id": "PruningStats", From 3132d9257677c88bda0e5122b78f7bc6671c73cf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:44 +0000 Subject: [PATCH 09/31] feat(bigqueryreservation): update the api #### bigqueryreservation:v1 The following keys were added: - schemas.Assignment.properties.principal.type (Total Keys: 1) --- docs/dyn/bigqueryreservation_v1.projects.locations.html | 2 ++ ...tion_v1.projects.locations.reservations.assignments.html | 6 ++++++ .../discovery_cache/documents/bigqueryreservation.v1.json | 6 +++++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.html index 9eee2360b9..ac67e9cb09 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.html @@ -168,6 +168,7 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -217,6 +218,7 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html index 91b98f542e..198379af9a 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html @@ -124,6 +124,7 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -145,6 +146,7 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -242,6 +244,7 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -294,6 +297,7 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -316,6 +320,7 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -337,6 +342,7 @@

Method Details

"enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index d1139f7b97..6722e1f21f 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -1282,7 +1282,7 @@ } } }, -"revision": "20260109", +"revision": "20260305", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1329,6 +1329,10 @@ "readOnly": true, "type": "string" }, +"principal": { +"description": "Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities.", +"type": "string" +}, "schedulingPolicy": { "$ref": "SchedulingPolicy", "description": "Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available." From 2dc2ec0afd7236cb60e543ad96bebdbb69cd36e9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:44 +0000 Subject: [PATCH 10/31] feat(ces): update the api #### ces:v1 The following keys were added: - schemas.AgentTool (Total Keys: 4) - schemas.ExecuteToolRequest.properties.context (Total Keys: 2) - schemas.ExportAppRequest.properties.appVersion.type (Total Keys: 1) - schemas.GenerateChatTokenRequest.properties.liveHandoffEnabled.type (Total Keys: 1) - schemas.McpTool.properties.customHeaders (Total Keys: 2) - schemas.McpToolset.properties.customHeaders (Total Keys: 2) - schemas.Tool.properties.agentTool.$ref (Total Keys: 1) - schemas.WidgetTool.properties.dataMapping.$ref (Total Keys: 1) - schemas.WidgetTool.properties.uiConfig (Total Keys: 2) - schemas.WidgetToolDataMapping (Total Keys: 7) #### ces:v1beta The following keys were added: - schemas.AgentTool (Total Keys: 4) - schemas.ExecuteToolRequest.properties.context (Total Keys: 2) - schemas.ExportAppRequest.properties.appVersion.type (Total Keys: 1) - schemas.GenerateChatTokenRequest.properties.liveHandoffEnabled.type (Total Keys: 1) - schemas.McpTool.properties.customHeaders (Total Keys: 2) - schemas.McpToolset.properties.customHeaders (Total Keys: 2) - schemas.Tool.properties.agentTool.$ref (Total Keys: 1) - schemas.WidgetTool.properties.dataMapping.$ref (Total Keys: 1) - schemas.WidgetTool.properties.uiConfig (Total Keys: 2) - schemas.WidgetToolDataMapping (Total Keys: 7) --- docs/dyn/ces_v1.projects.locations.apps.html | 4 + ...s_v1.projects.locations.apps.sessions.html | 5 +- .../ces_v1.projects.locations.apps.tools.html | 114 +++++++++++++++++ ...s_v1.projects.locations.apps.toolsets.html | 37 ++++++ ...s_v1.projects.locations.apps.versions.html | 88 +++++++++++++ .../ces_v1beta.projects.locations.apps.html | 4 + ...beta.projects.locations.apps.sessions.html | 5 +- ..._v1beta.projects.locations.apps.tools.html | 114 +++++++++++++++++ ...beta.projects.locations.apps.toolsets.html | 37 ++++++ ...beta.projects.locations.apps.versions.html | 88 +++++++++++++ .../discovery_cache/documents/ces.v1.json | 117 ++++++++++++++++-- .../discovery_cache/documents/ces.v1beta.json | 117 ++++++++++++++++-- 12 files changed, 712 insertions(+), 18 deletions(-) diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html index 1e874a6243..5112b12e91 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.html +++ b/docs/dyn/ces_v1.projects.locations.apps.html @@ -470,6 +470,9 @@

Method Details

"args": { # Optional. The input parameters and values for the tool in JSON object format. "a_key": "", # Properties of the object. }, + "context": { # Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool. + "a_key": "", # Properties of the object. + }, "tool": "A String", # Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -513,6 +516,7 @@

Method Details

The object takes the form of: { # Request message for AgentService.ExportApp. + "appVersion": "A String", # Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`. "exportFormat": "A String", # Required. The format to export the app in. "gcsUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object. } diff --git a/docs/dyn/ces_v1.projects.locations.apps.sessions.html b/docs/dyn/ces_v1.projects.locations.apps.sessions.html index 79e2bfd336..cc36aa9666 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.sessions.html @@ -82,7 +82,7 @@

Instance Methods

Generates a session scoped token for chat widget to authenticate with Session APIs.

runSession(session, body=None, x__xgafv=None)

-

Initiates a single turn interaction with the CES agent within a session.

+

Initiates a single-turn interaction with the CES agent within a session.

Method Details

close() @@ -100,6 +100,7 @@

Method Details

{ # Request message for WidgetService.GenerateChatToken. "deployment": "A String", # Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "liveHandoffEnabled": True or False, # Optional. Indicates if live handoff is enabled for the session. "recaptchaToken": "A String", # Optional. The reCAPTCHA token generated by the client-side chat widget. } @@ -119,7 +120,7 @@

Method Details

runSession(session, body=None, x__xgafv=None) -
Initiates a single turn interaction with the CES agent within a session.
+  
Initiates a single-turn interaction with the CES agent within a session.
 
 Args:
   session: string, Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}` (required)
diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html
index 993a60d7c7..e775f14632 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.tools.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html
@@ -111,6 +111,11 @@ 

Method Details

The object takes the form of: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -359,6 +364,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -503,6 +511,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -538,6 +554,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, } @@ -552,6 +571,11 @@

Method Details

An object of the form: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -800,6 +824,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -944,6 +971,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -979,6 +1014,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }
@@ -1019,6 +1057,11 @@

Method Details

An object of the form: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -1267,6 +1310,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -1411,6 +1457,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -1446,6 +1500,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }
@@ -1473,6 +1530,11 @@

Method Details

"nextPageToken": "A String", # A token that can be sent as ListToolsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. "tools": [ # The list of tools. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -1721,6 +1783,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -1865,6 +1930,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -1900,6 +1973,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -1931,6 +2007,11 @@

Method Details

The object takes the form of: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -2179,6 +2260,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -2323,6 +2407,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -2358,6 +2450,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, } @@ -2372,6 +2467,11 @@

Method Details

An object of the form: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -2620,6 +2720,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -2764,6 +2867,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -2799,6 +2910,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }
diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html index b74e5e9660..367fe365d1 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html @@ -175,6 +175,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -312,6 +315,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -475,6 +481,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -625,6 +634,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -779,6 +791,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -916,6 +931,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -1009,6 +1027,11 @@

Method Details

{ # Response message for ToolService.RetrieveTools. "tools": [ # The list of tools that are included in the specified toolset. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -1257,6 +1280,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -1401,6 +1427,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -1436,6 +1470,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index 663228565f..f2c39aeeec 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -623,6 +623,11 @@

Method Details

], "tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -871,6 +876,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -1015,6 +1023,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -1050,6 +1066,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -1117,6 +1136,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -1708,6 +1730,11 @@

Method Details

], "tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -1956,6 +1983,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -2100,6 +2130,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -2135,6 +2173,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -2202,6 +2243,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -2818,6 +2862,11 @@

Method Details

], "tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -3066,6 +3115,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -3210,6 +3262,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -3245,6 +3305,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -3312,6 +3375,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -3915,6 +3981,11 @@

Method Details

], "tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -4163,6 +4234,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -4307,6 +4381,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -4342,6 +4424,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -4409,6 +4494,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html index 809fb6ce0e..30e3ac04bf 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.html @@ -523,6 +523,9 @@

Method Details

"args": { # Optional. The input parameters and values for the tool in JSON object format. "a_key": "", # Properties of the object. }, + "context": { # Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool. + "a_key": "", # Properties of the object. + }, "tool": "A String", # Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -566,6 +569,7 @@

Method Details

The object takes the form of: { # Request message for AgentService.ExportApp. + "appVersion": "A String", # Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`. "exportFormat": "A String", # Required. The format to export the app in. "gcsUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object. } diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html index cc6e6c1d9d..af5f7cde1f 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html @@ -82,7 +82,7 @@

Instance Methods

Generates a session scoped token for chat widget to authenticate with Session APIs.

runSession(session, body=None, x__xgafv=None)

-

Initiates a single turn interaction with the CES agent within a session.

+

Initiates a single-turn interaction with the CES agent within a session.

Method Details

close() @@ -100,6 +100,7 @@

Method Details

{ # Request message for WidgetService.GenerateChatToken. "deployment": "A String", # Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "liveHandoffEnabled": True or False, # Optional. Indicates if live handoff is enabled for the session. "recaptchaToken": "A String", # Optional. The reCAPTCHA token generated by the client-side chat widget. } @@ -119,7 +120,7 @@

Method Details

runSession(session, body=None, x__xgafv=None) -
Initiates a single turn interaction with the CES agent within a session.
+  
Initiates a single-turn interaction with the CES agent within a session.
 
 Args:
   session: string, Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}` (required)
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html
index f0240ac3c2..36724936f6 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html
@@ -111,6 +111,11 @@ 

Method Details

The object takes the form of: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -359,6 +364,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -503,6 +511,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -538,6 +554,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, } @@ -552,6 +571,11 @@

Method Details

An object of the form: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -800,6 +824,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -944,6 +971,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -979,6 +1014,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }
@@ -1019,6 +1057,11 @@

Method Details

An object of the form: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -1267,6 +1310,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -1411,6 +1457,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -1446,6 +1500,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }
@@ -1473,6 +1530,11 @@

Method Details

"nextPageToken": "A String", # A token that can be sent as ListToolsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. "tools": [ # The list of tools. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -1721,6 +1783,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -1865,6 +1930,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -1900,6 +1973,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -1931,6 +2007,11 @@

Method Details

The object takes the form of: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -2179,6 +2260,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -2323,6 +2407,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -2358,6 +2450,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, } @@ -2372,6 +2467,11 @@

Method Details

An object of the form: { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -2620,6 +2720,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -2764,6 +2867,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -2799,6 +2910,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, } diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html index fa0d70c126..78e8bde783 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html @@ -175,6 +175,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -312,6 +315,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -475,6 +481,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -625,6 +634,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -779,6 +791,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -916,6 +931,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -1009,6 +1027,11 @@

Method Details

{ # Response message for ToolService.RetrieveTools. "tools": [ # The list of tools that are included in the specified toolset. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -1257,6 +1280,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -1401,6 +1427,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -1436,6 +1470,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index 0b8ca15dca..d4e9b0b015 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -642,6 +642,11 @@

Method Details

], "tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -890,6 +895,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -1034,6 +1042,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -1069,6 +1085,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -1136,6 +1155,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -1746,6 +1768,11 @@

Method Details

], "tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -1994,6 +2021,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -2138,6 +2168,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -2173,6 +2211,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -2240,6 +2281,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -2875,6 +2919,11 @@

Method Details

], "tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -3123,6 +3172,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -3267,6 +3319,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -3302,6 +3362,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -3369,6 +3432,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. @@ -3991,6 +4057,11 @@

Method Details

], "tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. + "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "description": "A String", # Optional. Description of the tool's purpose. + "name": "A String", # Required. The name of the agent tool. + "rootAgent": "A String", # Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` + }, "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function. "description": "A String", # Optional. The function description. "name": "A String", # Required. The function name. @@ -4239,6 +4310,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "description": "A String", # Optional. The description of the MCP tool. "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. @@ -4383,6 +4457,14 @@

Method Details

}, "updateTime": "A String", # Output only. Timestamp when the tool was last updated. "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool. + "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. + "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. + "a_key": "A String", + }, + "mode": "A String", # Optional. The mode of the data mapping. + "pythonScript": "A String", # Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings. + "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` + }, "description": "A String", # Optional. The description of the widget tool. "name": "A String", # Required. The display name of the widget tool. "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool. @@ -4418,6 +4500,9 @@

Method Details

"type": "A String", # Required. The type of the data. "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, + "uiConfig": { # Optional. Configuration for rendering the widget. + "a_key": "", # Properties of the object. + }, "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. }, }, @@ -4485,6 +4570,9 @@

Method Details

"serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. }, }, + "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details. + "a_key": "A String", + }, "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json index 020ea05867..132cbe0eae 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1.json +++ b/googleapiclient/discovery_cache/documents/ces.v1.json @@ -17,7 +17,7 @@ "canonicalName": "Customer Engagement Suite", "description": "", "discoveryVersion": "v1", -"documentationLink": "https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference", +"documentationLink": "https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps", "endpoints": [ { "description": "Regional Endpoint", @@ -1513,7 +1513,7 @@ ] }, "runSession": { -"description": "Initiates a single turn interaction with the CES agent within a session.", +"description": "Initiates a single-turn interaction with the CES agent within a session.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession", "httpMethod": "POST", "id": "ces.projects.locations.apps.sessions.runSession", @@ -2246,7 +2246,7 @@ } } }, -"revision": "20260227", +"revision": "20260312", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -2503,6 +2503,25 @@ }, "type": "object" }, +"AgentTool": { +"description": "Represents a tool that allows the agent to call another agent.", +"id": "AgentTool", +"properties": { +"description": { +"description": "Optional. Description of the tool's purpose.", +"type": "string" +}, +"name": { +"description": "Required. The name of the agent tool.", +"type": "string" +}, +"rootAgent": { +"description": "Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"type": "string" +} +}, +"type": "object" +}, "AgentTransfer": { "description": "Represents an event indicating the transfer of a conversation to a different agent.", "id": "AgentTransfer", @@ -3174,13 +3193,15 @@ "MODALITY_UNSPECIFIED", "CHAT_AND_VOICE", "VOICE_ONLY", -"CHAT_ONLY" +"CHAT_ONLY", +"CHAT_VOICE_AND_VIDEO" ], "enumDescriptions": [ "Unknown modality.", "Widget supports both chat and voice input.", "Widget supports only voice input.", -"Widget supports only chat input." +"Widget supports only chat input.", +"Widget supports chat, voice, and video input." ], "type": "string" }, @@ -4151,9 +4172,9 @@ "FALLBACK_RESPONSE" ], "enumDescriptions": [ -"Unspecified error handling strategy. Defaults to FALLBACK_RESPONSE.", +"Unspecified error handling strategy.", "No specific handling is enabled.", -"A fallback message will be returned to the user in case of LLM errors." +"A fallback message will be returned to the user in case of system errors (e.g. LLM errors)." ], "type": "string" } @@ -4371,6 +4392,14 @@ "description": "Optional. The input parameters and values for the tool in JSON object format.", "type": "object" }, +"context": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.", +"type": "object" +}, "tool": { "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" @@ -4425,6 +4454,10 @@ "description": "Request message for AgentService.ExportApp.", "id": "ExportAppRequest", "properties": { +"appVersion": { +"description": "Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.", +"type": "string" +}, "exportFormat": { "description": "Required. The format to export the app in.", "enum": [ @@ -4514,6 +4547,10 @@ "description": "Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}", "type": "string" }, +"liveHandoffEnabled": { +"description": "Optional. Indicates if live handoff is enabled for the session.", +"type": "boolean" +}, "recaptchaToken": { "description": "Optional. The reCAPTCHA token generated by the client-side chat widget.", "type": "string" @@ -5333,6 +5370,13 @@ "$ref": "ApiAuthentication", "description": "Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication." }, +"customHeaders": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.", +"type": "object" +}, "description": { "description": "Optional. The description of the MCP tool.", "type": "string" @@ -5372,6 +5416,13 @@ "$ref": "ApiAuthentication", "description": "Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication." }, +"customHeaders": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.", +"type": "object" +}, "serverAddress": { "description": "Required. The address of the MCP server, for example, \"https://example.com/mcp/\". If the server is built with the MCP SDK, the url should be suffixed with \"/mcp/\". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.", "type": "string" @@ -6495,6 +6546,10 @@ "description": "A tool represents an action that the CES agent can take to achieve certain goals.", "id": "Tool", "properties": { +"agentTool": { +"$ref": "AgentTool", +"description": "Optional. The agent tool." +}, "clientFunction": { "$ref": "ClientFunction", "description": "Optional. The client function." @@ -6921,6 +6976,10 @@ "description": "Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.", "id": "WidgetTool", "properties": { +"dataMapping": { +"$ref": "WidgetToolDataMapping", +"description": "Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters." +}, "description": { "description": "Optional. The description of the widget tool.", "type": "string" @@ -6933,6 +6992,14 @@ "$ref": "Schema", "description": "Optional. The input parameters of the widget tool." }, +"uiConfig": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Configuration for rendering the widget.", +"type": "object" +}, "widgetType": { "description": "Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.", "enum": [ @@ -6969,6 +7036,42 @@ } }, "type": "object" +}, +"WidgetToolDataMapping": { +"description": "Configuration for mapping data from a source tool to the widget's input parameters.", +"id": "WidgetToolDataMapping", +"properties": { +"fieldMappings": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.", +"type": "object" +}, +"mode": { +"description": "Optional. The mode of the data mapping.", +"enum": [ +"MODE_UNSPECIFIED", +"FIELD_MAPPING", +"PYTHON_SCRIPT" +], +"enumDescriptions": [ +"Unspecified mode.", +"Use the `field_mappings` map for data transformation.", +"Use the `python_script` for data transformation." +], +"type": "string" +}, +"pythonScript": { +"description": "Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings.", +"type": "string" +}, +"sourceToolName": { +"description": "Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json index 6d0c6a7fb1..abb31bd97a 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json @@ -17,7 +17,7 @@ "canonicalName": "Customer Engagement Suite", "description": "", "discoveryVersion": "v1", -"documentationLink": "https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference", +"documentationLink": "https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps", "endpoints": [ { "description": "Regional Endpoint", @@ -2656,7 +2656,7 @@ ] }, "runSession": { -"description": "Initiates a single turn interaction with the CES agent within a session.", +"description": "Initiates a single-turn interaction with the CES agent within a session.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession", "httpMethod": "POST", "id": "ces.projects.locations.apps.sessions.runSession", @@ -3389,7 +3389,7 @@ } } }, -"revision": "20260227", +"revision": "20260312", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -3646,6 +3646,25 @@ }, "type": "object" }, +"AgentTool": { +"description": "Represents a tool that allows the agent to call another agent.", +"id": "AgentTool", +"properties": { +"description": { +"description": "Optional. Description of the tool's purpose.", +"type": "string" +}, +"name": { +"description": "Required. The name of the agent tool.", +"type": "string" +}, +"rootAgent": { +"description": "Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"type": "string" +} +}, +"type": "object" +}, "AgentTransfer": { "description": "Represents an event indicating the transfer of a conversation to a different agent.", "id": "AgentTransfer", @@ -4577,13 +4596,15 @@ "MODALITY_UNSPECIFIED", "CHAT_AND_VOICE", "VOICE_ONLY", -"CHAT_ONLY" +"CHAT_ONLY", +"CHAT_VOICE_AND_VIDEO" ], "enumDescriptions": [ "Unknown modality.", "Widget supports both chat and voice input.", "Widget supports only voice input.", -"Widget supports only chat input." +"Widget supports only chat input.", +"Widget supports chat, voice, and video input." ], "type": "string" }, @@ -5560,9 +5581,9 @@ "FALLBACK_RESPONSE" ], "enumDescriptions": [ -"Unspecified error handling strategy. Defaults to FALLBACK_RESPONSE.", +"Unspecified error handling strategy.", "No specific handling is enabled.", -"A fallback message will be returned to the user in case of LLM errors." +"A fallback message will be returned to the user in case of system errors (e.g. LLM errors)." ], "type": "string" } @@ -7428,6 +7449,14 @@ "description": "Optional. The input parameters and values for the tool in JSON object format.", "type": "object" }, +"context": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.", +"type": "object" +}, "tool": { "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" @@ -7482,6 +7511,10 @@ "description": "Request message for AgentService.ExportApp.", "id": "ExportAppRequest", "properties": { +"appVersion": { +"description": "Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.", +"type": "string" +}, "exportFormat": { "description": "Required. The format to export the app in.", "enum": [ @@ -7663,6 +7696,10 @@ "description": "Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}", "type": "string" }, +"liveHandoffEnabled": { +"description": "Optional. Indicates if live handoff is enabled for the session.", +"type": "boolean" +}, "recaptchaToken": { "description": "Optional. The reCAPTCHA token generated by the client-side chat widget.", "type": "string" @@ -8890,6 +8927,13 @@ "$ref": "ApiAuthentication", "description": "Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication." }, +"customHeaders": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.", +"type": "object" +}, "description": { "description": "Optional. The description of the MCP tool.", "type": "string" @@ -8929,6 +8973,13 @@ "$ref": "ApiAuthentication", "description": "Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication." }, +"customHeaders": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.", +"type": "object" +}, "serverAddress": { "description": "Required. The address of the MCP server, for example, \"https://example.com/mcp/\". If the server is built with the MCP SDK, the url should be suffixed with \"/mcp/\". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.", "type": "string" @@ -10337,6 +10388,10 @@ "description": "A tool represents an action that the CES agent can take to achieve certain goals.", "id": "Tool", "properties": { +"agentTool": { +"$ref": "AgentTool", +"description": "Optional. The agent tool." +}, "clientFunction": { "$ref": "ClientFunction", "description": "Optional. The client function." @@ -10799,6 +10854,10 @@ "description": "Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.", "id": "WidgetTool", "properties": { +"dataMapping": { +"$ref": "WidgetToolDataMapping", +"description": "Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters." +}, "description": { "description": "Optional. The description of the widget tool.", "type": "string" @@ -10811,6 +10870,14 @@ "$ref": "Schema", "description": "Optional. The input parameters of the widget tool." }, +"uiConfig": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Configuration for rendering the widget.", +"type": "object" +}, "widgetType": { "description": "Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.", "enum": [ @@ -10847,6 +10914,42 @@ } }, "type": "object" +}, +"WidgetToolDataMapping": { +"description": "Configuration for mapping data from a source tool to the widget's input parameters.", +"id": "WidgetToolDataMapping", +"properties": { +"fieldMappings": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.", +"type": "object" +}, +"mode": { +"description": "Optional. The mode of the data mapping.", +"enum": [ +"MODE_UNSPECIFIED", +"FIELD_MAPPING", +"PYTHON_SCRIPT" +], +"enumDescriptions": [ +"Unspecified mode.", +"Use the `field_mappings` map for data transformation.", +"Use the `python_script` for data transformation." +], +"type": "string" +}, +"pythonScript": { +"description": "Optional. A Python script used to transform the source tool's output into the widget's input format. This is used when the mapping is too complex for simple field mappings.", +"type": "string" +}, +"sourceToolName": { +"description": "Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", From cffc11aaf58752e163fc930a4279b820ffe93daf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:44 +0000 Subject: [PATCH 11/31] feat(classroom): update the api #### classroom:v1 The following keys were added: - schemas.AddOnAttachmentStudentSubmission.properties.userId.type (Total Keys: 1) --- ...rses.courseWork.addOnAttachments.studentSubmissions.html | 3 +++ ...1.courses.posts.addOnAttachments.studentSubmissions.html | 3 +++ googleapiclient/discovery_cache/documents/classroom.v1.json | 6 +++++- 3 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/dyn/classroom_v1.courses.courseWork.addOnAttachments.studentSubmissions.html b/docs/dyn/classroom_v1.courses.courseWork.addOnAttachments.studentSubmissions.html index e5888bb76f..530a43c9eb 100644 --- a/docs/dyn/classroom_v1.courses.courseWork.addOnAttachments.studentSubmissions.html +++ b/docs/dyn/classroom_v1.courses.courseWork.addOnAttachments.studentSubmissions.html @@ -110,6 +110,7 @@

Method Details

{ # Payload for grade update requests. "pointsEarned": 3.14, # Student grade on this attachment. If unset, no grade was set. "postSubmissionState": "A String", # Submission state of add-on attachment's parent post (i.e. assignment). + "userId": "A String", # Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. Read-only. }
@@ -128,6 +129,7 @@

Method Details

{ # Payload for grade update requests. "pointsEarned": 3.14, # Student grade on this attachment. If unset, no grade was set. "postSubmissionState": "A String", # Submission state of add-on attachment's parent post (i.e. assignment). + "userId": "A String", # Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. Read-only. } postId: string, Optional. Deprecated, use `item_id` instead. @@ -143,6 +145,7 @@

Method Details

{ # Payload for grade update requests. "pointsEarned": 3.14, # Student grade on this attachment. If unset, no grade was set. "postSubmissionState": "A String", # Submission state of add-on attachment's parent post (i.e. assignment). + "userId": "A String", # Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. Read-only. }
diff --git a/docs/dyn/classroom_v1.courses.posts.addOnAttachments.studentSubmissions.html b/docs/dyn/classroom_v1.courses.posts.addOnAttachments.studentSubmissions.html index 96d57edc98..3742f34707 100644 --- a/docs/dyn/classroom_v1.courses.posts.addOnAttachments.studentSubmissions.html +++ b/docs/dyn/classroom_v1.courses.posts.addOnAttachments.studentSubmissions.html @@ -110,6 +110,7 @@

Method Details

{ # Payload for grade update requests. "pointsEarned": 3.14, # Student grade on this attachment. If unset, no grade was set. "postSubmissionState": "A String", # Submission state of add-on attachment's parent post (i.e. assignment). + "userId": "A String", # Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. Read-only. }
@@ -128,6 +129,7 @@

Method Details

{ # Payload for grade update requests. "pointsEarned": 3.14, # Student grade on this attachment. If unset, no grade was set. "postSubmissionState": "A String", # Submission state of add-on attachment's parent post (i.e. assignment). + "userId": "A String", # Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. Read-only. } itemId: string, Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. @@ -143,6 +145,7 @@

Method Details

{ # Payload for grade update requests. "pointsEarned": 3.14, # Student grade on this attachment. If unset, no grade was set. "postSubmissionState": "A String", # Submission state of add-on attachment's parent post (i.e. assignment). + "userId": "A String", # Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. Read-only. } diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index d1237f8e1a..6a27e848a7 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -4366,7 +4366,7 @@ } } }, -"revision": "20260111", +"revision": "20260310", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { @@ -4458,6 +4458,10 @@ "Student chose to \"unsubmit\" the assignment." ], "type": "string" +}, +"userId": { +"description": "Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. Read-only.", +"type": "string" } }, "type": "object" From a4d5055d1829938f95c5b6455771b3b39fd86f98 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:44 +0000 Subject: [PATCH 12/31] feat(cloudbuild): update the api #### cloudbuild:v1 The following keys were added: - schemas.Artifacts.properties.oci (Total Keys: 2) - schemas.BuiltImage.properties.ociMediaType (Total Keys: 2) - schemas.Oci (Total Keys: 6) --- docs/dyn/cloudbuild_v1.projects.builds.html | 40 +++++++++++++ ...oudbuild_v1.projects.locations.builds.html | 40 +++++++++++++ ...dbuild_v1.projects.locations.triggers.html | 60 +++++++++++++++++++ docs/dyn/cloudbuild_v1.projects.triggers.html | 60 +++++++++++++++++++ .../documents/cloudbuild.v1.json | 58 ++++++++++++++++-- 5 files changed, 253 insertions(+), 5 deletions(-) diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html index 894fe64e9a..02c7086e1b 100644 --- a/docs/dyn/cloudbuild_v1.projects.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.builds.html @@ -225,6 +225,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -353,6 +362,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -645,6 +655,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -773,6 +792,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -1096,6 +1116,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -1224,6 +1253,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -1522,6 +1552,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -1650,6 +1689,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index 41c6efce5c..b01df413bc 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -224,6 +224,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -352,6 +361,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -644,6 +654,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -772,6 +791,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -1095,6 +1115,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -1223,6 +1252,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -1521,6 +1551,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -1649,6 +1688,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index e095141661..42c8c44ee6 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -213,6 +213,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -341,6 +350,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -816,6 +826,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -944,6 +963,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -1447,6 +1467,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -1575,6 +1604,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -2062,6 +2092,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -2190,6 +2229,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -2682,6 +2722,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -2810,6 +2859,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -3287,6 +3337,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -3415,6 +3474,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index d7197e6e56..088aa158ca 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -213,6 +213,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -341,6 +350,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -816,6 +826,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -944,6 +963,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -1447,6 +1467,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -1575,6 +1604,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -2062,6 +2092,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -2190,6 +2229,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -2683,6 +2723,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -2811,6 +2860,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. @@ -3286,6 +3336,15 @@

Method Details

"startTime": "A String", # Start of time span. }, }, + "oci": [ # Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE. + { # OCI image to upload to Artifact Registry upon successful completion of all build steps. + "file": "A String", # Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar + "registryPath": "A String", # Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image + "tags": [ # Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0 + "A String", + ], + }, + ], "pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE. { # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository. "paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. @@ -3414,6 +3473,7 @@

Method Details

"artifactRegistryPackage": "A String", # Output only. Path to the artifact in Artifact Registry. "digest": "A String", # Docker Registry 2.0 digest. "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. + "ociMediaType": "A String", # Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value. "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. "endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index 3011ebb964..aba0d81760 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2583,7 +2583,7 @@ } } }, -"revision": "20260106", +"revision": "20260309", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -2725,6 +2725,13 @@ "$ref": "ArtifactObjects", "description": "A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE." }, +"oci": { +"description": "Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE.", +"items": { +"$ref": "Oci" +}, +"type": "array" +}, "pythonPackages": { "description": "A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.", "items": { @@ -3403,14 +3410,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" }, @@ -3744,6 +3753,21 @@ false "description": "Name used to push the container image to Google Container Registry, as presented to `docker push`.", "type": "string" }, +"ociMediaType": { +"description": "Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value.", +"enum": [ +"OCI_MEDIA_TYPE_UNSPECIFIED", +"IMAGE_MANIFEST", +"IMAGE_INDEX" +], +"enumDescriptions": [ +"Default value.", +"The artifact is an image manifest, which represents a single image with all its layers.", +"The artifact is an image index, which can contain a list of image manifests." +], +"readOnly": true, +"type": "string" +}, "pushTiming": { "$ref": "TimeSpan", "description": "Output only. Stores timing information for pushing the specified image.", @@ -4649,14 +4673,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" }, @@ -4940,6 +4966,28 @@ false }, "type": "object" }, +"Oci": { +"description": "OCI image to upload to Artifact Registry upon successful completion of all build steps.", +"id": "Oci", +"properties": { +"file": { +"description": "Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar", +"type": "string" +}, +"registryPath": { +"description": "Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image", +"type": "string" +}, +"tags": { +"description": "Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", From 5eefc0e054eb1923754ef247815a90bf5855fe69 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:44 +0000 Subject: [PATCH 13/31] feat(cloudidentity): update the api #### cloudidentity:v1beta1 The following keys were added: - schemas.BrowserInfo.properties.policies (Total Keys: 3) - schemas.ChromePolicy (Total Keys: 13) - schemas.Device.properties.browserProfiles (Total Keys: 2) - schemas.PolicyConflict (Total Keys: 8) --- docs/dyn/cloudidentity_v1beta1.devices.html | 168 +++++++++++++++++- .../documents/cloudidentity.v1beta1.json | 152 +++++++++++++++- 2 files changed, 310 insertions(+), 10 deletions(-) diff --git a/docs/dyn/cloudidentity_v1beta1.devices.html b/docs/dyn/cloudidentity_v1beta1.devices.html index a84b663da0..f8d0feb44e 100644 --- a/docs/dyn/cloudidentity_v1beta1.devices.html +++ b/docs/dyn/cloudidentity_v1beta1.devices.html @@ -176,6 +176,43 @@

Method Details

"basebandVersion": "A String", # Output only. Baseband version of the device. "bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7. "brand": "A String", # Output only. Device brand. Example: Samsung. + "browserProfiles": [ # Browser profiles on the device. This is a copy of the BrowserAttributes message defined in EndpointVerificationSpecificAttributes. We are replicating it here since EndpointVerification isn't the only client reporting browser profiles. + { # Contains information about browser profiles reported by the Clients on the device (e.g. [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)). + "chromeBrowserInfo": { # Browser-specific fields reported by clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). # Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + "browserManagementState": "A String", # Output only. Browser's management state. + "browserVersion": "A String", # Version of the request initiating browser. E.g. `91.0.4442.4`. + "isBuiltInDnsClientEnabled": True or False, # Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled). + "isBulkDataEntryAnalysisEnabled": True or False, # Current state of [bulk data analysis](https://chromeenterprise.google/policies/#OnBulkDataEntryEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isChromeCleanupEnabled": True or False, # Deprecated: This field is not used for Chrome version 118 and later. Current state of [Chrome Cleanup](https://chromeenterprise.google/policies/#ChromeCleanupEnabled). + "isChromeRemoteDesktopAppBlocked": True or False, # Current state of [Chrome Remote Desktop app](https://chromeenterprise.google/policies/#URLBlocklist). + "isFileDownloadAnalysisEnabled": True or False, # Current state of [file download analysis](https://chromeenterprise.google/policies/#OnFileDownloadedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isFileUploadAnalysisEnabled": True or False, # Current state of [file upload analysis](https://chromeenterprise.google/policies/#OnFileAttachedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isRealtimeUrlCheckEnabled": True or False, # Current state of [real-time URL check](https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode). Set to true if provider list from Chrome is non-empty. + "isSecurityEventAnalysisEnabled": True or False, # Current state of [security event analysis](https://chromeenterprise.google/policies/#OnSecurityEventEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isSiteIsolationEnabled": True or False, # Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins). + "isThirdPartyBlockingEnabled": True or False, # Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled). + "passwordProtectionWarningTrigger": "A String", # Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger). + "policies": [ # Output only. Chrome policies information for the browser as can be seen in chrome://policy. Full possibilities of policies can be consulted in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/). + { # Represents a Chrome policy and its current state. + "conflicts": [ # Output only. A list of other policy values for the same policy name that were not applied due to lower precedence. This field is empty if there were no conflicts. + { # Represents a policy value from a source that was not applied because a higher-priority source took precedence. + "scope": "A String", # Output only. The scope at which this lower-priority policy is set (USER or MACHINE). + "source": "A String", # Output only. The source from which this lower-priority policy value originated. + "value": "A String", # Output only. The policy value from this lower-priority source. + }, + ], + "name": "A String", # Output only. The unique name of the Chrome policy. These names correspond to the policy names listed in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/) + "scope": "A String", # Output only. The scope at which the *applied* policy value is set (USER or MACHINE). + "source": "A String", # Output only. The source from which the *applied* policy value originated. + "value": "A String", # Output only. The currently applied value of the policy. The format depends on the policy type (e.g., boolean, string, JSON array/object). + }, + ], + "safeBrowsingProtectionLevel": "A String", # Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel). + }, + "chromeProfileId": "A String", # Chrome profile ID that is exposed by the Chrome API. It is unique for each device. + "lastProfileSyncTime": "A String", # Timestamp in milliseconds since the Unix epoch when the profile/gcm id was last synced. + }, + ], "buildNumber": "A String", # Output only. Build number of the device. "clientTypes": [ # List of the clients the device is reporting to. "A String", @@ -192,8 +229,8 @@

Method Details

"a_key": "", # Properties of the object. }, "browserAttributes": [ # Details of browser profiles reported by Endpoint Verification. - { # Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). - "chromeBrowserInfo": { # Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). # Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + { # Contains information about browser profiles reported by the Clients on the device (e.g. [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)). + "chromeBrowserInfo": { # Browser-specific fields reported by clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). # Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). "browserManagementState": "A String", # Output only. Browser's management state. "browserVersion": "A String", # Version of the request initiating browser. E.g. `91.0.4442.4`. "isBuiltInDnsClientEnabled": True or False, # Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled). @@ -207,6 +244,21 @@

Method Details

"isSiteIsolationEnabled": True or False, # Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins). "isThirdPartyBlockingEnabled": True or False, # Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled). "passwordProtectionWarningTrigger": "A String", # Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger). + "policies": [ # Output only. Chrome policies information for the browser as can be seen in chrome://policy. Full possibilities of policies can be consulted in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/). + { # Represents a Chrome policy and its current state. + "conflicts": [ # Output only. A list of other policy values for the same policy name that were not applied due to lower precedence. This field is empty if there were no conflicts. + { # Represents a policy value from a source that was not applied because a higher-priority source took precedence. + "scope": "A String", # Output only. The scope at which this lower-priority policy is set (USER or MACHINE). + "source": "A String", # Output only. The source from which this lower-priority policy value originated. + "value": "A String", # Output only. The policy value from this lower-priority source. + }, + ], + "name": "A String", # Output only. The unique name of the Chrome policy. These names correspond to the policy names listed in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/) + "scope": "A String", # Output only. The scope at which the *applied* policy value is set (USER or MACHINE). + "source": "A String", # Output only. The source from which the *applied* policy value originated. + "value": "A String", # Output only. The currently applied value of the policy. The format depends on the policy type (e.g., boolean, string, JSON array/object). + }, + ], "safeBrowsingProtectionLevel": "A String", # Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel). }, "chromeProfileId": "A String", # Chrome profile ID that is exposed by the Chrome API. It is unique for each device. @@ -351,6 +403,43 @@

Method Details

"basebandVersion": "A String", # Output only. Baseband version of the device. "bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7. "brand": "A String", # Output only. Device brand. Example: Samsung. + "browserProfiles": [ # Browser profiles on the device. This is a copy of the BrowserAttributes message defined in EndpointVerificationSpecificAttributes. We are replicating it here since EndpointVerification isn't the only client reporting browser profiles. + { # Contains information about browser profiles reported by the Clients on the device (e.g. [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)). + "chromeBrowserInfo": { # Browser-specific fields reported by clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). # Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + "browserManagementState": "A String", # Output only. Browser's management state. + "browserVersion": "A String", # Version of the request initiating browser. E.g. `91.0.4442.4`. + "isBuiltInDnsClientEnabled": True or False, # Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled). + "isBulkDataEntryAnalysisEnabled": True or False, # Current state of [bulk data analysis](https://chromeenterprise.google/policies/#OnBulkDataEntryEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isChromeCleanupEnabled": True or False, # Deprecated: This field is not used for Chrome version 118 and later. Current state of [Chrome Cleanup](https://chromeenterprise.google/policies/#ChromeCleanupEnabled). + "isChromeRemoteDesktopAppBlocked": True or False, # Current state of [Chrome Remote Desktop app](https://chromeenterprise.google/policies/#URLBlocklist). + "isFileDownloadAnalysisEnabled": True or False, # Current state of [file download analysis](https://chromeenterprise.google/policies/#OnFileDownloadedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isFileUploadAnalysisEnabled": True or False, # Current state of [file upload analysis](https://chromeenterprise.google/policies/#OnFileAttachedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isRealtimeUrlCheckEnabled": True or False, # Current state of [real-time URL check](https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode). Set to true if provider list from Chrome is non-empty. + "isSecurityEventAnalysisEnabled": True or False, # Current state of [security event analysis](https://chromeenterprise.google/policies/#OnSecurityEventEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isSiteIsolationEnabled": True or False, # Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins). + "isThirdPartyBlockingEnabled": True or False, # Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled). + "passwordProtectionWarningTrigger": "A String", # Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger). + "policies": [ # Output only. Chrome policies information for the browser as can be seen in chrome://policy. Full possibilities of policies can be consulted in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/). + { # Represents a Chrome policy and its current state. + "conflicts": [ # Output only. A list of other policy values for the same policy name that were not applied due to lower precedence. This field is empty if there were no conflicts. + { # Represents a policy value from a source that was not applied because a higher-priority source took precedence. + "scope": "A String", # Output only. The scope at which this lower-priority policy is set (USER or MACHINE). + "source": "A String", # Output only. The source from which this lower-priority policy value originated. + "value": "A String", # Output only. The policy value from this lower-priority source. + }, + ], + "name": "A String", # Output only. The unique name of the Chrome policy. These names correspond to the policy names listed in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/) + "scope": "A String", # Output only. The scope at which the *applied* policy value is set (USER or MACHINE). + "source": "A String", # Output only. The source from which the *applied* policy value originated. + "value": "A String", # Output only. The currently applied value of the policy. The format depends on the policy type (e.g., boolean, string, JSON array/object). + }, + ], + "safeBrowsingProtectionLevel": "A String", # Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel). + }, + "chromeProfileId": "A String", # Chrome profile ID that is exposed by the Chrome API. It is unique for each device. + "lastProfileSyncTime": "A String", # Timestamp in milliseconds since the Unix epoch when the profile/gcm id was last synced. + }, + ], "buildNumber": "A String", # Output only. Build number of the device. "clientTypes": [ # List of the clients the device is reporting to. "A String", @@ -367,8 +456,8 @@

Method Details

"a_key": "", # Properties of the object. }, "browserAttributes": [ # Details of browser profiles reported by Endpoint Verification. - { # Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). - "chromeBrowserInfo": { # Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). # Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + { # Contains information about browser profiles reported by the Clients on the device (e.g. [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)). + "chromeBrowserInfo": { # Browser-specific fields reported by clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). # Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). "browserManagementState": "A String", # Output only. Browser's management state. "browserVersion": "A String", # Version of the request initiating browser. E.g. `91.0.4442.4`. "isBuiltInDnsClientEnabled": True or False, # Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled). @@ -382,6 +471,21 @@

Method Details

"isSiteIsolationEnabled": True or False, # Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins). "isThirdPartyBlockingEnabled": True or False, # Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled). "passwordProtectionWarningTrigger": "A String", # Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger). + "policies": [ # Output only. Chrome policies information for the browser as can be seen in chrome://policy. Full possibilities of policies can be consulted in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/). + { # Represents a Chrome policy and its current state. + "conflicts": [ # Output only. A list of other policy values for the same policy name that were not applied due to lower precedence. This field is empty if there were no conflicts. + { # Represents a policy value from a source that was not applied because a higher-priority source took precedence. + "scope": "A String", # Output only. The scope at which this lower-priority policy is set (USER or MACHINE). + "source": "A String", # Output only. The source from which this lower-priority policy value originated. + "value": "A String", # Output only. The policy value from this lower-priority source. + }, + ], + "name": "A String", # Output only. The unique name of the Chrome policy. These names correspond to the policy names listed in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/) + "scope": "A String", # Output only. The scope at which the *applied* policy value is set (USER or MACHINE). + "source": "A String", # Output only. The source from which the *applied* policy value originated. + "value": "A String", # Output only. The currently applied value of the policy. The format depends on the policy type (e.g., boolean, string, JSON array/object). + }, + ], "safeBrowsingProtectionLevel": "A String", # Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel). }, "chromeProfileId": "A String", # Chrome profile ID that is exposed by the Chrome API. It is unique for each device. @@ -471,6 +575,43 @@

Method Details

"basebandVersion": "A String", # Output only. Baseband version of the device. "bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7. "brand": "A String", # Output only. Device brand. Example: Samsung. + "browserProfiles": [ # Browser profiles on the device. This is a copy of the BrowserAttributes message defined in EndpointVerificationSpecificAttributes. We are replicating it here since EndpointVerification isn't the only client reporting browser profiles. + { # Contains information about browser profiles reported by the Clients on the device (e.g. [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)). + "chromeBrowserInfo": { # Browser-specific fields reported by clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). # Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + "browserManagementState": "A String", # Output only. Browser's management state. + "browserVersion": "A String", # Version of the request initiating browser. E.g. `91.0.4442.4`. + "isBuiltInDnsClientEnabled": True or False, # Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled). + "isBulkDataEntryAnalysisEnabled": True or False, # Current state of [bulk data analysis](https://chromeenterprise.google/policies/#OnBulkDataEntryEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isChromeCleanupEnabled": True or False, # Deprecated: This field is not used for Chrome version 118 and later. Current state of [Chrome Cleanup](https://chromeenterprise.google/policies/#ChromeCleanupEnabled). + "isChromeRemoteDesktopAppBlocked": True or False, # Current state of [Chrome Remote Desktop app](https://chromeenterprise.google/policies/#URLBlocklist). + "isFileDownloadAnalysisEnabled": True or False, # Current state of [file download analysis](https://chromeenterprise.google/policies/#OnFileDownloadedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isFileUploadAnalysisEnabled": True or False, # Current state of [file upload analysis](https://chromeenterprise.google/policies/#OnFileAttachedEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isRealtimeUrlCheckEnabled": True or False, # Current state of [real-time URL check](https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode). Set to true if provider list from Chrome is non-empty. + "isSecurityEventAnalysisEnabled": True or False, # Current state of [security event analysis](https://chromeenterprise.google/policies/#OnSecurityEventEnterpriseConnector). Set to true if provider list from Chrome is non-empty. + "isSiteIsolationEnabled": True or False, # Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins). + "isThirdPartyBlockingEnabled": True or False, # Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled). + "passwordProtectionWarningTrigger": "A String", # Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger). + "policies": [ # Output only. Chrome policies information for the browser as can be seen in chrome://policy. Full possibilities of policies can be consulted in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/). + { # Represents a Chrome policy and its current state. + "conflicts": [ # Output only. A list of other policy values for the same policy name that were not applied due to lower precedence. This field is empty if there were no conflicts. + { # Represents a policy value from a source that was not applied because a higher-priority source took precedence. + "scope": "A String", # Output only. The scope at which this lower-priority policy is set (USER or MACHINE). + "source": "A String", # Output only. The source from which this lower-priority policy value originated. + "value": "A String", # Output only. The policy value from this lower-priority source. + }, + ], + "name": "A String", # Output only. The unique name of the Chrome policy. These names correspond to the policy names listed in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/) + "scope": "A String", # Output only. The scope at which the *applied* policy value is set (USER or MACHINE). + "source": "A String", # Output only. The source from which the *applied* policy value originated. + "value": "A String", # Output only. The currently applied value of the policy. The format depends on the policy type (e.g., boolean, string, JSON array/object). + }, + ], + "safeBrowsingProtectionLevel": "A String", # Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel). + }, + "chromeProfileId": "A String", # Chrome profile ID that is exposed by the Chrome API. It is unique for each device. + "lastProfileSyncTime": "A String", # Timestamp in milliseconds since the Unix epoch when the profile/gcm id was last synced. + }, + ], "buildNumber": "A String", # Output only. Build number of the device. "clientTypes": [ # List of the clients the device is reporting to. "A String", @@ -487,8 +628,8 @@

Method Details

"a_key": "", # Properties of the object. }, "browserAttributes": [ # Details of browser profiles reported by Endpoint Verification. - { # Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). - "chromeBrowserInfo": { # Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). # Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). + { # Contains information about browser profiles reported by the Clients on the device (e.g. [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)). + "chromeBrowserInfo": { # Browser-specific fields reported by clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). # Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). "browserManagementState": "A String", # Output only. Browser's management state. "browserVersion": "A String", # Version of the request initiating browser. E.g. `91.0.4442.4`. "isBuiltInDnsClientEnabled": True or False, # Current state of [built-in DNS client](https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled). @@ -502,6 +643,21 @@

Method Details

"isSiteIsolationEnabled": True or False, # Current state of [site isolation](https://chromeenterprise.google/policies/?policy=IsolateOrigins). "isThirdPartyBlockingEnabled": True or False, # Current state of [third-party blocking](https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled). "passwordProtectionWarningTrigger": "A String", # Current state of [password protection trigger](https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger). + "policies": [ # Output only. Chrome policies information for the browser as can be seen in chrome://policy. Full possibilities of policies can be consulted in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/). + { # Represents a Chrome policy and its current state. + "conflicts": [ # Output only. A list of other policy values for the same policy name that were not applied due to lower precedence. This field is empty if there were no conflicts. + { # Represents a policy value from a source that was not applied because a higher-priority source took precedence. + "scope": "A String", # Output only. The scope at which this lower-priority policy is set (USER or MACHINE). + "source": "A String", # Output only. The source from which this lower-priority policy value originated. + "value": "A String", # Output only. The policy value from this lower-priority source. + }, + ], + "name": "A String", # Output only. The unique name of the Chrome policy. These names correspond to the policy names listed in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/) + "scope": "A String", # Output only. The scope at which the *applied* policy value is set (USER or MACHINE). + "source": "A String", # Output only. The source from which the *applied* policy value originated. + "value": "A String", # Output only. The currently applied value of the policy. The format depends on the policy type (e.g., boolean, string, JSON array/object). + }, + ], "safeBrowsingProtectionLevel": "A String", # Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel). }, "chromeProfileId": "A String", # Chrome profile ID that is exposed by the Chrome API. It is unique for each device. diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index 7431a1eca6..35c81b042f 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2349,7 +2349,7 @@ } } }, -"revision": "20260113", +"revision": "20260310", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -2470,12 +2470,12 @@ "type": "object" }, "BrowserAttributes": { -"description": "Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).", +"description": "Contains information about browser profiles reported by the Clients on the device (e.g. [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)).", "id": "BrowserAttributes", "properties": { "chromeBrowserInfo": { "$ref": "BrowserInfo", -"description": "Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)." +"description": "Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)." }, "chromeProfileId": { "description": "Chrome profile ID that is exposed by the Chrome API. It is unique for each device.", @@ -2490,7 +2490,7 @@ "type": "object" }, "BrowserInfo": { -"description": "Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).", +"description": "Browser-specific fields reported by clients on the device, such as [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).", "id": "BrowserInfo", "properties": { "browserManagementState": { @@ -2573,6 +2573,14 @@ ], "type": "string" }, +"policies": { +"description": "Output only. Chrome policies information for the browser as can be seen in chrome://policy. Full possibilities of policies can be consulted in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/).", +"items": { +"$ref": "ChromePolicy" +}, +"readOnly": true, +"type": "array" +}, "safeBrowsingProtectionLevel": { "description": "Current state of [Safe Browsing protection level](https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel).", "enum": [ @@ -2729,6 +2737,77 @@ }, "type": "object" }, +"ChromePolicy": { +"description": "Represents a Chrome policy and its current state.", +"id": "ChromePolicy", +"properties": { +"conflicts": { +"description": "Output only. A list of other policy values for the same policy name that were not applied due to lower precedence. This field is empty if there were no conflicts.", +"items": { +"$ref": "PolicyConflict" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Output only. The unique name of the Chrome policy. These names correspond to the policy names listed in [Chrome Enterprise Policy List](https://chromeenterprise.google/policies/)", +"readOnly": true, +"type": "string" +}, +"scope": { +"description": "Output only. The scope at which the *applied* policy value is set (USER or MACHINE).", +"enum": [ +"SCOPE_UNKNOWN", +"USER", +"MACHINE" +], +"enumDescriptions": [ +"Default value. The policy scope is unknown or not specified.", +"User-level policy. This scope indicates the policy applies to the specific user session or profile. For cloud policies, this is typically the signed-in Chrome profile. On some platforms like Windows, this can also refer to the OS user.", +"Machine-level policy. This scope indicates the policy applies system-wide to all users on the current machine or device." +], +"readOnly": true, +"type": "string" +}, +"source": { +"description": "Output only. The source from which the *applied* policy value originated.", +"enum": [ +"SOURCE_UNKNOWN", +"ENTERPRISE_DEFAULT", +"CLOUD", +"ACTIVE_DIRECTORY", +"DEVICE_LOCAL_ACCOUNT_OVERRIDE_DEPRECATED", +"PLATFORM", +"PRIORITY_CLOUD_DEPRECATED", +"MERGED", +"COMMAND_LINE", +"CLOUD_FROM_ASH", +"RESTRICTED_MANAGED_GUEST_SESSION_OVERRIDE" +], +"enumDescriptions": [ +"Default value. The policy source is unknown or not specified.", +"The policy is provided by Chrome's default settings when running in an enterprise environment.", +"The policy is managed and pushed from a cloud-based administration console, such as the Google Admin console.", +"The policy is sourced from Active Directory, primarily for Active Directory-managed ChromeOS devices.", +"Deprecated: Formerly used when a policy was overridden by ChromeOS for public sessions or kiosk mode.", +"The policy is set by OS built-in tool on desktop.", +"Deprecated: Formerly used for cloud policies with higher priority.", +"The applied policy value is the result of a merge from multiple policy sources.", +"The policy is set using a command line argument passed to the Chrome executable, usually intended for development or testing.", +"For ChromeOS, this indicates a policy set by cloud management in the Ash browser and then made available to the Lacros browser.", +"The policy is set by the restricted managed guest session override." +], +"readOnly": true, +"type": "string" +}, +"value": { +"description": "Output only. The currently applied value of the policy. The format depends on the policy type (e.g., boolean, string, JSON array/object).", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ClientState": { "description": "Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users", "id": "ClientState", @@ -2957,6 +3036,13 @@ "readOnly": true, "type": "string" }, +"browserProfiles": { +"description": "Browser profiles on the device. This is a copy of the BrowserAttributes message defined in EndpointVerificationSpecificAttributes. We are replicating it here since EndpointVerification isn't the only client reporting browser profiles.", +"items": { +"$ref": "BrowserAttributes" +}, +"type": "array" +}, "buildNumber": { "description": "Output only. Build number of the device.", "readOnly": true, @@ -5316,6 +5402,64 @@ }, "type": "object" }, +"PolicyConflict": { +"description": "Represents a policy value from a source that was not applied because a higher-priority source took precedence.", +"id": "PolicyConflict", +"properties": { +"scope": { +"description": "Output only. The scope at which this lower-priority policy is set (USER or MACHINE).", +"enum": [ +"SCOPE_UNKNOWN", +"USER", +"MACHINE" +], +"enumDescriptions": [ +"Default value. The policy scope is unknown or not specified.", +"User-level policy. This scope indicates the policy applies to the specific user session or profile. For cloud policies, this is typically the signed-in Chrome profile. On some platforms like Windows, this can also refer to the OS user.", +"Machine-level policy. This scope indicates the policy applies system-wide to all users on the current machine or device." +], +"readOnly": true, +"type": "string" +}, +"source": { +"description": "Output only. The source from which this lower-priority policy value originated.", +"enum": [ +"SOURCE_UNKNOWN", +"ENTERPRISE_DEFAULT", +"CLOUD", +"ACTIVE_DIRECTORY", +"DEVICE_LOCAL_ACCOUNT_OVERRIDE_DEPRECATED", +"PLATFORM", +"PRIORITY_CLOUD_DEPRECATED", +"MERGED", +"COMMAND_LINE", +"CLOUD_FROM_ASH", +"RESTRICTED_MANAGED_GUEST_SESSION_OVERRIDE" +], +"enumDescriptions": [ +"Default value. The policy source is unknown or not specified.", +"The policy is provided by Chrome's default settings when running in an enterprise environment.", +"The policy is managed and pushed from a cloud-based administration console, such as the Google Admin console.", +"The policy is sourced from Active Directory, primarily for Active Directory-managed ChromeOS devices.", +"Deprecated: Formerly used when a policy was overridden by ChromeOS for public sessions or kiosk mode.", +"The policy is set by OS built-in tool on desktop.", +"Deprecated: Formerly used for cloud policies with higher priority.", +"The applied policy value is the result of a merge from multiple policy sources.", +"The policy is set using a command line argument passed to the Chrome executable, usually intended for development or testing.", +"For ChromeOS, this indicates a policy set by cloud management in the Ash browser and then made available to the Lacros browser.", +"The policy is set by the restricted managed guest session override." +], +"readOnly": true, +"type": "string" +}, +"value": { +"description": "Output only. The policy value from this lower-priority source.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "PolicyQuery": { "description": "PolicyQuery", "id": "PolicyQuery", From 166ea8146c4387cb03395ccba85c64970dab52de Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:45 +0000 Subject: [PATCH 14/31] feat(compute): update the api #### compute:alpha The following keys were deleted: - schemas.BackendService.properties.vpcNetworkScope.type (Total Keys: 1) The following keys were added: - schemas.CapacityAdviceRequestInstanceProperties.properties.acceleratorTopology.type (Total Keys: 1) - schemas.InstanceGroupManagersConfigureAcceleratorTopologiesRequest.properties.acceleratorTopologyConfigurations (Total Keys: 2) - schemas.InstanceGroupManagersConfigureAcceleratorTopologiesRequestAcceleratorTopologyConfiguration (Total Keys: 4) - schemas.InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyState.properties.externalId.type (Total Keys: 1) - schemas.InstanceGroupManagersResizeAdvancedRequest.properties.scaleInProtection.type (Total Keys: 1) - schemas.PublicAdvertisedPrefix.properties.networkTier.type (Total Keys: 1) - schemas.PublicDelegatedPrefix.properties.networkTier.type (Total Keys: 1) - schemas.RegionInstanceGroupManagersResizeAdvancedRequest.properties.scaleInProtection.type (Total Keys: 1) - schemas.Rollout.properties.pauseTime (Total Keys: 2) - schemas.Rollout.properties.resumeTime (Total Keys: 2) - schemas.SubnetworkSecondaryRange.properties.ipCollection.type (Total Keys: 1) - schemas.SubnetworkSecondaryRange.properties.ipVersion.type (Total Keys: 1) #### compute:beta The following keys were added: - schemas.FutureReservation.properties.confidentialComputeType.type (Total Keys: 1) - schemas.InstanceGroupManagersConfigureAcceleratorTopologiesRequest.properties.acceleratorTopologyConfigurations (Total Keys: 2) - schemas.InstanceGroupManagersConfigureAcceleratorTopologiesRequestAcceleratorTopologyConfiguration (Total Keys: 4) - schemas.InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyState.properties.externalId.type (Total Keys: 1) - schemas.Reservation.properties.confidentialComputeType.type (Total Keys: 1) #### compute:v1 The following keys were added: - resources.instanceTemplates.methods.get.parameters.view (Total Keys: 2) - resources.instanceTemplates.methods.list.parameters.view (Total Keys: 2) - resources.instances.methods.get.parameters.view (Total Keys: 2) - resources.instances.methods.getPartnerMetadata (Total Keys: 21) - resources.instances.methods.list.parameters.view (Total Keys: 2) - resources.instances.methods.patchPartnerMetadata (Total Keys: 22) - resources.regionInstanceGroupManagerResizeRequests.methods.cancel (Total Keys: 22) - resources.regionInstanceGroupManagerResizeRequests.methods.delete (Total Keys: 22) - resources.regionInstanceGroupManagerResizeRequests.methods.get (Total Keys: 20) - resources.regionInstanceGroupManagerResizeRequests.methods.insert (Total Keys: 20) - resources.regionInstanceGroupManagerResizeRequests.methods.list (Total Keys: 30) - resources.regionInstanceTemplates.methods.get.parameters.view (Total Keys: 2) - resources.regionInstanceTemplates.methods.list.parameters.view (Total Keys: 2) - resources.zoneVmExtensionPolicies.methods.delete (Total Keys: 20) - resources.zoneVmExtensionPolicies.methods.get (Total Keys: 19) - resources.zoneVmExtensionPolicies.methods.insert (Total Keys: 18) - resources.zoneVmExtensionPolicies.methods.list (Total Keys: 28) - resources.zoneVmExtensionPolicies.methods.update (Total Keys: 21) - schemas.FutureReservation.properties.confidentialComputeType.type (Total Keys: 1) - schemas.Instance.properties.partnerMetadata (Total Keys: 2) - schemas.InstanceGroupManagerResizeRequest.properties.region (Total Keys: 2) - schemas.InstanceGroupManagerStatus.properties.currentInstanceStatuses (Total Keys: 2) - schemas.InstanceGroupManagerStatusInstanceStatusSummary (Total Keys: 41) - schemas.InstanceProperties.properties.partnerMetadata (Total Keys: 2) - schemas.PartnerMetadata (Total Keys: 6) - schemas.RegionInstanceGroupManagerResizeRequestsListResponse (Total Keys: 24) - schemas.Reservation.properties.confidentialComputeType.type (Total Keys: 1) - schemas.StructuredEntries (Total Keys: 5) - schemas.VmExtensionPolicy (Total Keys: 67) --- docs/dyn/compute_alpha.advice.html | 3 + docs/dyn/compute_alpha.backendServices.html | 70 - ...e_alpha.globalPublicDelegatedPrefixes.html | 12 + docs/dyn/compute_alpha.imageFamilyViews.html | 8 +- docs/dyn/compute_alpha.images.html | 40 +- .../compute_alpha.instanceGroupManagers.html | 20 + ...ompute_alpha.publicAdvertisedPrefixes.html | 12 + ...compute_alpha.publicDelegatedPrefixes.html | 15 + .../compute_alpha.regionBackendServices.html | 60 - ...ute_alpha.regionInstanceGroupManagers.html | 2 + docs/dyn/compute_alpha.rollouts.html | 4 + docs/dyn/compute_alpha.subnetworks.html | 40 + docs/dyn/compute_beta.futureReservations.html | 5 + docs/dyn/compute_beta.imageFamilyViews.html | 8 +- docs/dyn/compute_beta.images.html | 40 +- .../compute_beta.instanceGroupManagers.html | 18 + docs/dyn/compute_beta.regionCommitments.html | 6 + docs/dyn/compute_beta.reservations.html | 5 + docs/dyn/compute_v1.futureReservations.html | 5 + docs/dyn/compute_v1.html | 10 + docs/dyn/compute_v1.imageFamilyViews.html | 8 +- docs/dyn/compute_v1.images.html | 40 +- ...v1.instanceGroupManagerResizeRequests.html | 9 + .../dyn/compute_v1.instanceGroupManagers.html | 195 ++ docs/dyn/compute_v1.instanceTemplates.html | 54 +- docs/dyn/compute_v1.instances.html | 430 +++- docs/dyn/compute_v1.machineImages.html | 27 + docs/dyn/compute_v1.regionCommitments.html | 5 + ...ionInstanceGroupManagerResizeRequests.html | 1935 +++++++++++++++++ ...ompute_v1.regionInstanceGroupManagers.html | 156 ++ .../compute_v1.regionInstanceTemplates.html | 45 +- docs/dyn/compute_v1.regionInstances.html | 9 + docs/dyn/compute_v1.reservations.html | 5 + .../compute_v1.zoneVmExtensionPolicies.html | 1401 ++++++++++++ .../documents/compute.alpha.json | 132 +- .../documents/compute.beta.json | 67 +- .../discovery_cache/documents/compute.v1.json | 1456 ++++++++++++- 37 files changed, 6085 insertions(+), 272 deletions(-) create mode 100644 docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html create mode 100644 docs/dyn/compute_v1.zoneVmExtensionPolicies.html diff --git a/docs/dyn/compute_alpha.advice.html b/docs/dyn/compute_alpha.advice.html index 8b536677d8..114773d0f0 100644 --- a/docs/dyn/compute_alpha.advice.html +++ b/docs/dyn/compute_alpha.advice.html @@ -248,6 +248,9 @@

Method Details

}, }, "instanceProperties": { # Instance provisining properties. # Instance properties for this request. + "acceleratorTopology": "A String", # Input only. Specifies the topology required to create a partition for + # VMs that have interconnected GPUs or TPUs. + # Example values: 2x2 for ct5l-hightpu-4t. "scheduling": { # Defines the instance scheduling options. # Specifies the scheduling options. "maxRunDuration": "A String", # The maximum time that instances can run before Compute Engine # terminates them. diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 5040cc3f5a..6cf583a9e7 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -2311,16 +2311,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "warning": { # Informational warning which replaces the list of @@ -4761,16 +4751,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } @@ -7733,16 +7713,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -9881,16 +9851,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "kind": "compute#backendServiceList", # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services. @@ -11777,16 +11737,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "kind": "compute#usableBackendServiceList", # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend @@ -13616,16 +13566,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -17186,16 +17126,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html index de8c369cc2..230a2ed8f0 100644 --- a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html @@ -448,6 +448,9 @@

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. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -568,6 +571,9 @@

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. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1063,6 +1069,9 @@

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. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1235,6 +1244,9 @@

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. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public diff --git a/docs/dyn/compute_alpha.imageFamilyViews.html b/docs/dyn/compute_alpha.imageFamilyViews.html index 7721935a8a..80bc5d2c2a 100644 --- a/docs/dyn/compute_alpha.imageFamilyViews.html +++ b/docs/dyn/compute_alpha.imageFamilyViews.html @@ -339,12 +339,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # diff --git a/docs/dyn/compute_alpha.images.html b/docs/dyn/compute_alpha.images.html index bdc197dbde..d35a01bc67 100644 --- a/docs/dyn/compute_alpha.images.html +++ b/docs/dyn/compute_alpha.images.html @@ -1002,12 +1002,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -1555,12 +1557,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -2468,12 +2472,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -3396,12 +3402,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -3991,12 +3999,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index 346cb10028..3b5e97fdac 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -2896,6 +2896,19 @@

Method Details

# obtained from the GetAvailableAcceleratorTopologies rpc. "a_key": "A String", }, + "acceleratorTopologyConfigurations": { # Map of accelerator topologies that should have their state changed to + # the specified configuration. The map key is the hashed topology locus id. + # It can be obtained from the GetAvailableAcceleratorTopologies rpc. + "a_key": { # Configuration for a single accelerator topology. + "action": "A String", + "externalId": "A String", # Identifier of the accelerator topology assigned externally to + # differentiate who is the owner of the topology. The format needs to + # conform to RFC1035 and be unique. The uniqueness is guaranteed by the + # requestor. If it is provided on activating the sub-slice it will have to + # be provided on deactivating as well. This identifier is cleared on + # successful deform of a sub-slice. + }, + }, } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -6466,6 +6479,11 @@

Method Details

], }, "errorTimestamp": "A String", # Timestamp when the last error happened + "externalId": "A String", # Identifier of the accelerator topology assigned externally to + # differentiate who is the owner of the topology. This is set in + # ConfigureAcceleratorTopologies. If it is provided on activating the + # sub-slice it will have to be provided on deactivating as well. + # This identifier is cleared on successful deform of a sub-slice. }, "instancesHealth": "A String", "parent": "A String", # Identified by the topology Id in the accelerator_topology_info map. Empty @@ -15615,6 +15633,8 @@

Method Details

# # You can see which instances is being creating in which mode by calling # the get or listManagedInstances API. + "scaleInProtection": True or False, # If this flag is enabled within a request to decrease a MIG's target size, + # then the MIG declines that request. "targetSize": 42, # The number of running instances that the managed instance group should # maintain at any given time. The group automatically adds or removes # instances to maintain the number of instances specified by this parameter. diff --git a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html index e764f60633..c049e5b031 100644 --- a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html @@ -738,6 +738,9 @@

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. + "networkTier": "A String", # Network tier to be used for this prefix. All child delegated prefixes will + # inherit this field. If this field is not specified, it defaults to the + # network tier of the project that the PublicAdvertisedPrefix belongs to. "pdpScope": "A String", # Specifies how child public delegated prefix will be scoped. It could # be one of following values: # @@ -820,6 +823,9 @@

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. + "networkTier": "A String", # Network tier to be used for this prefix. All child delegated prefixes will + # inherit this field. If this field is not specified, it defaults to the + # network tier of the project that the PublicAdvertisedPrefix belongs to. "pdpScope": "A String", # Specifies how child public delegated prefix will be scoped. It could # be one of following values: # @@ -1277,6 +1283,9 @@

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. + "networkTier": "A String", # Network tier to be used for this prefix. All child delegated prefixes will + # inherit this field. If this field is not specified, it defaults to the + # network tier of the project that the PublicAdvertisedPrefix belongs to. "pdpScope": "A String", # Specifies how child public delegated prefix will be scoped. It could # be one of following values: # @@ -1410,6 +1419,9 @@

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. + "networkTier": "A String", # Network tier to be used for this prefix. All child delegated prefixes will + # inherit this field. If this field is not specified, it defaults to the + # network tier of the project that the PublicAdvertisedPrefix belongs to. "pdpScope": "A String", # Specifies how child public delegated prefix will be scoped. It could # be one of following values: # diff --git a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html index a27754e084..6740773d26 100644 --- a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html @@ -263,6 +263,9 @@

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. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1063,6 +1066,9 @@

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. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1184,6 +1190,9 @@

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. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1680,6 +1689,9 @@

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. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public @@ -1853,6 +1865,9 @@

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. + "networkTier": "A String", # Network tier of the public delegated prefix. If populated, it must match + # the network tier of the parent public advertised prefix. If not populated, + # it defaults to the network tier of the parent public advertised prefix. "parentPrefix": "A String", # The URL of parent prefix. Either PublicAdvertisedPrefix or # PublicDelegatedPrefix. "publicDelegatedSubPrefixs": [ # The list of sub public delegated prefixes that exist for this public diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index c42ef654e7..20de580017 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -2184,16 +2184,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } @@ -4383,16 +4373,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -6532,16 +6512,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "kind": "compute#backendServiceList", # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services. @@ -8431,16 +8401,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "kind": "compute#usableBackendServiceList", # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend @@ -10271,16 +10231,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -13545,16 +13495,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index a7d9a6e93f..0d6d66515b 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -13460,6 +13460,8 @@

Method Details

# # You can see which instances ar being created in which mode by calling # the get or listManagedInstances API. + "scaleInProtection": True or False, # If this flag is enabled within a request to decrease a MIG's target size, + # then the MIG declines that request. "targetSize": 42, # The number of running instances that the managed instance group should # maintain at any given time. The group automatically adds or removes # instances to maintain the number of instances specified by this parameter. diff --git a/docs/dyn/compute_alpha.rollouts.html b/docs/dyn/compute_alpha.rollouts.html index 5bb71104f9..9af2ce1381 100644 --- a/docs/dyn/compute_alpha.rollouts.html +++ b/docs/dyn/compute_alpha.rollouts.html @@ -735,6 +735,8 @@

Method Details

# 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. + "pauseTime": "A String", # Output only. The timestamp at which the Rollout was paused. + "resumeTime": "A String", # Output only. The timestamp at which the Rollout was resumed. "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out. "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model. # integration model with ProgressiveRollout. @@ -921,6 +923,8 @@

Method Details

# 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. + "pauseTime": "A String", # Output only. The timestamp at which the Rollout was paused. + "resumeTime": "A String", # Output only. The timestamp at which the Rollout was resumed. "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out. "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model. # integration model with ProgressiveRollout. diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html index dad45c5428..e2a0e9bc6b 100644 --- a/docs/dyn/compute_alpha.subnetworks.html +++ b/docs/dyn/compute_alpha.subnetworks.html @@ -452,6 +452,14 @@

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. @@ -1444,6 +1452,14 @@

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. @@ -2109,6 +2125,14 @@

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. @@ -2789,6 +2813,14 @@

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. @@ -3363,6 +3395,14 @@

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. diff --git a/docs/dyn/compute_beta.futureReservations.html b/docs/dyn/compute_beta.futureReservations.html index dfcb8c69e3..393a0a771e 100644 --- a/docs/dyn/compute_beta.futureReservations.html +++ b/docs/dyn/compute_beta.futureReservations.html @@ -293,6 +293,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. @@ -1292,6 +1293,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. @@ -1614,6 +1616,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. @@ -2314,6 +2317,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. @@ -2689,6 +2693,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. diff --git a/docs/dyn/compute_beta.imageFamilyViews.html b/docs/dyn/compute_beta.imageFamilyViews.html index ecb47eddfa..53462120f1 100644 --- a/docs/dyn/compute_beta.imageFamilyViews.html +++ b/docs/dyn/compute_beta.imageFamilyViews.html @@ -339,12 +339,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # diff --git a/docs/dyn/compute_beta.images.html b/docs/dyn/compute_beta.images.html index 7ee8a1d2c0..7770173fcc 100644 --- a/docs/dyn/compute_beta.images.html +++ b/docs/dyn/compute_beta.images.html @@ -1000,12 +1000,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -1552,12 +1554,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -2464,12 +2468,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -3390,12 +3396,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -3984,12 +3992,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index 930cfb9612..df83939b93 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -2310,6 +2310,19 @@

Method Details

# obtained from the GetAvailableAcceleratorTopologies rpc. "a_key": "A String", }, + "acceleratorTopologyConfigurations": { # Map of accelerator topologies that should have their state changed to + # the specified configuration. The map key is the hashed topology locus id. + # It can be obtained from the GetAvailableAcceleratorTopologies rpc. + "a_key": { # Configuration for a single accelerator topology. + "action": "A String", + "externalId": "A String", # Identifier of the accelerator topology assigned externally to + # differentiate who is the owner of the topology. The format needs to + # conform to RFC1035 and be unique. The uniqueness is guaranteed by the + # requestor. If it is provided on activating the sub-slice it will have to + # be provided on deactivating as well. This identifier is cleared on + # successful deform of a sub-slice. + }, + }, } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -5290,6 +5303,11 @@

Method Details

], }, "errorTimestamp": "A String", # Timestamp when the last error happened + "externalId": "A String", # Identifier of the accelerator topology assigned externally to + # differentiate who is the owner of the topology. This is set in + # ConfigureAcceleratorTopologies. If it is provided on activating the + # sub-slice it will have to be provided on deactivating as well. + # This identifier is cleared on successful deform of a sub-slice. }, "instancesHealth": "A String", "parent": "A String", # Identified by the topology Id in the accelerator_topology_info map. Empty diff --git a/docs/dyn/compute_beta.regionCommitments.html b/docs/dyn/compute_beta.regionCommitments.html index 35e04f793c..6817025975 100644 --- a/docs/dyn/compute_beta.regionCommitments.html +++ b/docs/dyn/compute_beta.regionCommitments.html @@ -331,6 +331,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -804,6 +805,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -1187,6 +1189,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -1945,6 +1948,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -2413,6 +2417,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -3014,6 +3019,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will diff --git a/docs/dyn/compute_beta.reservations.html b/docs/dyn/compute_beta.reservations.html index 66b89e9811..49cf96892b 100644 --- a/docs/dyn/compute_beta.reservations.html +++ b/docs/dyn/compute_beta.reservations.html @@ -272,6 +272,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -907,6 +908,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -1529,6 +1531,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -2158,6 +2161,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -3973,6 +3977,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will diff --git a/docs/dyn/compute_v1.futureReservations.html b/docs/dyn/compute_v1.futureReservations.html index 3f4e661e29..d89e91b9e0 100644 --- a/docs/dyn/compute_v1.futureReservations.html +++ b/docs/dyn/compute_v1.futureReservations.html @@ -283,6 +283,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. @@ -1253,6 +1254,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. @@ -1546,6 +1548,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. @@ -2217,6 +2220,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. @@ -2563,6 +2567,7 @@

Method Details

# parent commitments will be extended to match the end date of the plan for # this commitment. }, + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 # text format. "deploymentType": "A String", # Type of the deployment requested as part of future reservation. diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html index 6045d20c8e..2a6163097c 100644 --- a/docs/dyn/compute_v1.html +++ b/docs/dyn/compute_v1.html @@ -409,6 +409,11 @@

Instance Methods

Returns the regionHealthSources Resource.

+

+ regionInstanceGroupManagerResizeRequests() +

+

Returns the regionInstanceGroupManagerResizeRequests Resource.

+

regionInstanceGroupManagers()

@@ -644,6 +649,11 @@

Instance Methods

Returns the zoneOperations Resource.

+

+ zoneVmExtensionPolicies() +

+

Returns the zoneVmExtensionPolicies Resource.

+

zones()

diff --git a/docs/dyn/compute_v1.imageFamilyViews.html b/docs/dyn/compute_v1.imageFamilyViews.html index 497df85fd4..2acb7f0d37 100644 --- a/docs/dyn/compute_v1.imageFamilyViews.html +++ b/docs/dyn/compute_v1.imageFamilyViews.html @@ -286,12 +286,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html index 07ed9304a5..0849194027 100644 --- a/docs/dyn/compute_v1.images.html +++ b/docs/dyn/compute_v1.images.html @@ -926,12 +926,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -1403,12 +1405,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -2240,12 +2244,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -3090,12 +3096,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # @@ -3609,12 +3617,14 @@

Method Details

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. # An optional SHA1 checksum of the disk image before unpackaging provided # by the client when the disk image is created. - "source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is - # stored. - # The following are valid formats for the URL: + "source": "A String", # The full Google Cloud Storage URL or Artifact Registry path where the raw + # disk image archive is stored. + # The following are valid formats: # # - https://storage.googleapis.com/bucket_name/image_archive_name # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id + # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value # # # diff --git a/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html index 88113670dc..d953687159 100644 --- a/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html @@ -734,6 +734,9 @@

Method Details

# resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. + "region": "A String", # Output only. [Output Only] The URL of aregion + # where the resize request is located. Populated only for regional resize + # requests. "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request. # At the end of the run duration instance will be deleted. # as a count of seconds and fractions of seconds at nanosecond @@ -999,6 +1002,9 @@

Method Details

# resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. + "region": "A String", # Output only. [Output Only] The URL of aregion + # where the resize request is located. Populated only for regional resize + # requests. "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request. # At the end of the run duration instance will be deleted. # as a count of seconds and fractions of seconds at nanosecond @@ -1636,6 +1642,9 @@

Method Details

# resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. + "region": "A String", # Output only. [Output Only] The URL of aregion + # where the resize request is located. Populated only for regional resize + # requests. "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request. # At the end of the run duration instance will be deleted. # as a count of seconds and fractions of seconds at nanosecond diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index 2651706438..05c5a53b62 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -1085,6 +1085,45 @@

Method Details

# operation. Timestamp is in RFC3339 text format. }, }, + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + # in this managed instance group that have the status. Currently only shown + # for TPU MIGs + # instance group that have the status. For more information about how to + # interpret each status check the instance lifecycle documentation. + # Currently only shown for TPU MIGs. + "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have DEPROVISIONING status. + "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + # have been deleted. Includes only instances that would be shown in the + # listManagedInstances method and not all instances that have been + # deleted in the lifetime of the MIG. + # Does not include FlexStart instances that are waiting for the resources + # availability, they are considered as 'pending'. + "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING status, that is FlexStart instances that are waiting + # for resources. Instances that do not exist because of the other reasons + # are counted as 'non_existent'. + "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING_STOP status. + "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PROVISIONING status. + "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have REPAIRING status. + "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have RUNNING status. + "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STAGING status. + "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPED status. + "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPING status. + "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDED status. + "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDING status. + "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have TERMINATED status. + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -3503,6 +3542,45 @@

Method Details

# operation. Timestamp is in RFC3339 text format. }, }, + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + # in this managed instance group that have the status. Currently only shown + # for TPU MIGs + # instance group that have the status. For more information about how to + # interpret each status check the instance lifecycle documentation. + # Currently only shown for TPU MIGs. + "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have DEPROVISIONING status. + "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + # have been deleted. Includes only instances that would be shown in the + # listManagedInstances method and not all instances that have been + # deleted in the lifetime of the MIG. + # Does not include FlexStart instances that are waiting for the resources + # availability, they are considered as 'pending'. + "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING status, that is FlexStart instances that are waiting + # for resources. Instances that do not exist because of the other reasons + # are counted as 'non_existent'. + "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING_STOP status. + "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PROVISIONING status. + "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have REPAIRING status. + "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have RUNNING status. + "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STAGING status. + "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPED status. + "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPING status. + "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDED status. + "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDING status. + "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have TERMINATED status. + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -4222,6 +4300,45 @@

Method Details

# operation. Timestamp is in RFC3339 text format. }, }, + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + # in this managed instance group that have the status. Currently only shown + # for TPU MIGs + # instance group that have the status. For more information about how to + # interpret each status check the instance lifecycle documentation. + # Currently only shown for TPU MIGs. + "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have DEPROVISIONING status. + "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + # have been deleted. Includes only instances that would be shown in the + # listManagedInstances method and not all instances that have been + # deleted in the lifetime of the MIG. + # Does not include FlexStart instances that are waiting for the resources + # availability, they are considered as 'pending'. + "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING status, that is FlexStart instances that are waiting + # for resources. Instances that do not exist because of the other reasons + # are counted as 'non_existent'. + "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING_STOP status. + "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PROVISIONING status. + "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have REPAIRING status. + "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have RUNNING status. + "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STAGING status. + "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPED status. + "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPING status. + "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDED status. + "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDING status. + "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have TERMINATED status. + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -5307,6 +5424,45 @@

Method Details

# operation. Timestamp is in RFC3339 text format. }, }, + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + # in this managed instance group that have the status. Currently only shown + # for TPU MIGs + # instance group that have the status. For more information about how to + # interpret each status check the instance lifecycle documentation. + # Currently only shown for TPU MIGs. + "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have DEPROVISIONING status. + "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + # have been deleted. Includes only instances that would be shown in the + # listManagedInstances method and not all instances that have been + # deleted in the lifetime of the MIG. + # Does not include FlexStart instances that are waiting for the resources + # availability, they are considered as 'pending'. + "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING status, that is FlexStart instances that are waiting + # for resources. Instances that do not exist because of the other reasons + # are counted as 'non_existent'. + "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING_STOP status. + "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PROVISIONING status. + "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have REPAIRING status. + "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have RUNNING status. + "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STAGING status. + "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPED status. + "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPING status. + "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDED status. + "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDING status. + "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have TERMINATED status. + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -6841,6 +6997,45 @@

Method Details

# operation. Timestamp is in RFC3339 text format. }, }, + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + # in this managed instance group that have the status. Currently only shown + # for TPU MIGs + # instance group that have the status. For more information about how to + # interpret each status check the instance lifecycle documentation. + # Currently only shown for TPU MIGs. + "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have DEPROVISIONING status. + "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + # have been deleted. Includes only instances that would be shown in the + # listManagedInstances method and not all instances that have been + # deleted in the lifetime of the MIG. + # Does not include FlexStart instances that are waiting for the resources + # availability, they are considered as 'pending'. + "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING status, that is FlexStart instances that are waiting + # for resources. Instances that do not exist because of the other reasons + # are counted as 'non_existent'. + "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING_STOP status. + "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PROVISIONING status. + "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have REPAIRING status. + "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have RUNNING status. + "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STAGING status. + "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPED status. + "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPING status. + "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDED status. + "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDING status. + "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have TERMINATED status. + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index f781a83dff..6ac5ae03d7 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -87,7 +87,7 @@

Instance Methods

delete(project, instanceTemplate, requestId=None, x__xgafv=None)

Deletes the specified instance template. Deleting an instance template is

- get(project, instanceTemplate, x__xgafv=None)

+ get(project, instanceTemplate, view=None, x__xgafv=None)

Returns the specified instance template.

getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

@@ -96,7 +96,7 @@

Instance Methods

insert(project, body=None, requestId=None, x__xgafv=None)

Creates an instance template in the specified project using the

- list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)

Retrieves a list of instance templates that are contained within

list_next()

@@ -962,6 +962,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -1540,12 +1549,17 @@

Method Details

- get(project, instanceTemplate, x__xgafv=None) + get(project, instanceTemplate, view=None, x__xgafv=None)
Returns the specified instance template.
 
 Args:
   project: string, Project ID for this request. (required)
   instanceTemplate: string, The name of the instance template. (required)
+  view: string, View of the instance template.
+    Allowed values
+      BASIC - Include everything except Partner Metadata.
+      FULL - Include everything.
+      INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -2292,6 +2306,15 @@ 

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -3613,6 +3636,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -4100,7 +4132,7 @@

Method Details

- list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)
Retrieves a list of instance templates that are contained within
 the specified project.
 
@@ -4189,6 +4221,11 @@ 

Method Details

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. + view: string, View of the instance template. + Allowed values + BASIC - Include everything except Partner Metadata. + FULL - Include everything. + INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -4938,6 +4975,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index c011337ce6..e1539d98a9 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -111,7 +111,7 @@

Instance Methods

detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)

Detaches a disk from an instance.

- get(project, zone, instance, x__xgafv=None)

+ get(project, zone, instance, view=None, x__xgafv=None)

Returns the specified Instance resource.

getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)

@@ -122,6 +122,9 @@

Instance Methods

getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such

+

+ getPartnerMetadata(project, zone, instance, namespaces=None, x__xgafv=None)

+

Gets partner metadata of the specified instance and namespaces.

getScreenshot(project, zone, instance, x__xgafv=None)

Returns the screenshot from the specified instance.

@@ -135,7 +138,7 @@

Instance Methods

insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)

Creates an instance resource in the specified project using the data

- list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)

Retrieves the list of instances contained within

listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

@@ -146,6 +149,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ patchPartnerMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)

+

Patches partner metadata of the specified instance.

performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)

Perform a manual maintenance on the instance.

@@ -2328,6 +2334,15 @@

Method Details

"a_key": "A String", }, }, + "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain + # (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -4601,6 +4616,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -6305,13 +6329,18 @@

Method Details

- get(project, zone, instance, x__xgafv=None) + get(project, zone, instance, view=None, x__xgafv=None)
Returns the specified Instance resource.
 
 Args:
   project: string, Project ID for this request. (required)
   zone: string, The name of the zone for this request. (required)
   instance: string, Name of the instance resource to return. (required)
+  view: string, View of the instance.
+    Allowed values
+      BASIC - Include everything except Partner Metadata.
+      FULL - Include everything.
+      INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -7170,6 +7199,15 @@ 

Method Details

"a_key": "A String", }, }, + "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain + # (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -8399,6 +8437,43 @@

Method Details

}
+
+ getPartnerMetadata(project, zone, instance, namespaces=None, x__xgafv=None) +
Gets partner metadata of the specified instance and namespaces.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  instance: string, Name of the instance scoping this request. (required)
+  namespaces: string, Comma separated partner metadata namespaces.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Model definition of partner_metadata field.
+    # To be used in dedicated Partner Metadata methods and to be inlined in
+    # the Instance and InstanceTemplate resources.
+  "fingerprint": "A String", # Instance-level hash to be used for optimistic
+      # locking.
+  "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain to
+      # entries map. Subdomain name must be compliant withRFC1035
+      # definition. The total size of all keys and values must be less than 2MB.
+      # Subdomain 'metadata.compute.googleapis.com' is reserverd for instance's
+      # metadata.
+    "a_key": {
+      "entries": { # Map of a partner metadata that belong to the same subdomain.
+          # It accepts any value including google.protobuf.Struct.
+        "a_key": "",
+      },
+    },
+  },
+}
+
+
getScreenshot(project, zone, instance, x__xgafv=None)
Returns the screenshot from the specified instance.
@@ -9376,6 +9451,15 @@ 

Method Details

"a_key": "A String", }, }, + "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain + # (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -9960,7 +10044,7 @@

Method Details

- list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)
Retrieves the list of instances contained within
 the specified zone.
 
@@ -10050,6 +10134,11 @@ 

Method Details

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. + view: string, View of the instance. + Allowed values + BASIC - Include everything except Partner Metadata. + FULL - Include everything. + INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -10911,6 +11000,15 @@

Method Details

"a_key": "A String", }, }, + "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain + # (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. @@ -11409,6 +11507,321 @@

Method Details

+
+ patchPartnerMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None) +
Patches partner metadata of the specified instance.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  instance: string, Name of the instance scoping this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Model definition of partner_metadata field.
+    # To be used in dedicated Partner Metadata methods and to be inlined in
+    # the Instance and InstanceTemplate resources.
+  "fingerprint": "A String", # Instance-level hash to be used for optimistic
+      # locking.
+  "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain to
+      # entries map. Subdomain name must be compliant withRFC1035
+      # definition. The total size of all keys and values must be less than 2MB.
+      # Subdomain 'metadata.compute.googleapis.com' is reserverd for instance's
+      # metadata.
+    "a_key": {
+      "entries": { # Map of a partner metadata that belong to the same subdomain.
+          # It accepts any value including google.protobuf.Struct.
+        "a_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.
+
+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.
+}
+
+
performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)
Perform a manual maintenance on the instance.
@@ -20309,6 +20722,15 @@ 

Method Details

"a_key": "A String", }, }, + "partnerMetadata": { # Partner Metadata assigned to the instance. A map from a subdomain + # (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. # If not specified, use INHERIT_FROM_SUBNETWORK as default. "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index a4a9d61b59..a2a08a7a2e 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -1139,6 +1139,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -3066,6 +3075,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -4998,6 +5016,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. diff --git a/docs/dyn/compute_v1.regionCommitments.html b/docs/dyn/compute_v1.regionCommitments.html index 1425c35009..be91fa2620 100644 --- a/docs/dyn/compute_v1.regionCommitments.html +++ b/docs/dyn/compute_v1.regionCommitments.html @@ -320,6 +320,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -778,6 +779,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -1146,6 +1148,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -1889,6 +1892,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -2308,6 +2312,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html new file mode 100644 index 0000000000..7de91b7422 --- /dev/null +++ b/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html @@ -0,0 +1,1935 @@ + + + +

Compute Engine API . regionInstanceGroupManagerResizeRequests

+

Instance Methods

+

+ cancel(project, region, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None)

+

Cancels the specified resize request.

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, region, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None)

+

Deletes the specified, inactive resize request. Requests that are still

+

+ get(project, region, instanceGroupManager, resizeRequest, x__xgafv=None)

+

Returns all of the details about the specified resize request.

+

+ insert(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+

Creates a new Resize Request that starts provisioning VMs immediately

+

+ list(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves a list of Resize Requests that are contained in the

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(project, region, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None) +
Cancels the specified resize request.
+Cancelled resize request no longer waits for the resources to be
+provisioned. Cancel is only possible for requests that are in accepted
+state.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region
+scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group.
+Name should conform to RFC1035 or be a resource ID. (required)
+  resizeRequest: string, The name of the resize request to cancel.
+Name should conform to RFC1035 or be a resource ID. (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.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, region, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None) +
Deletes the specified, inactive resize request. Requests that are still
+active cannot be deleted. Deleting request does not delete instances that
+were provisioned previously.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region
+scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group.
+Name should conform to RFC1035 or be a resource ID. (required)
+  resizeRequest: string, The name of the resize request to delete.
+Name should conform to RFC1035 or be a resource ID. (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, instanceGroupManager, resizeRequest, x__xgafv=None) +
Returns all of the details about the specified resize request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region
+scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group.
+Name should conform to RFC1035 or be a resource ID. (required)
+  resizeRequest: string, The name of the resize request.
+Name should conform to RFC1035 or be a resource ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # InstanceGroupManagerResizeRequest represents a request to create
+    # a number of VMs: either immediately or by queuing the request for the
+    # specified time. This resize request is nested under InstanceGroupManager
+    # and the VMs created by this request are added to the owning
+    # InstanceGroupManager.
+  "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this resize request inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+      # generates this identifier.
+  "kind": "compute#instanceGroupManagerResizeRequest", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for
+      # resize requests.
+  "name": "A String", # The name of this resize request. The name must be 1-63 characters
+      # long, and comply withRFC1035.
+  "region": "A String", # Output only. [Output Only] The URL of aregion
+      # where the resize request is located. Populated only for regional resize
+      # requests.
+  "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request.
+      # At the end of the run duration instance will be deleted.
+      # 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
+  },
+  "resizeBy": 42, # The number of instances to be created by this resize request. The group's
+      # target size will be increased by this number. This field cannot be used
+      # together with 'instances'.
+  "selfLink": "A String", # Output only. [Output Only] The URL for this resize request. The server defines
+      # this URL.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "state": "A String", # Output only. [Output only] Current state of the request.
+  "status": { # Output only. [Output only] Status of the request.
+    "error": { # Output only. [Output only] Fatal errors encountered during the queueing or
+        # provisioning phases of the ResizeRequest that caused the transition to
+        # the FAILED state. Contrary to the last_attempt errors, this field is
+        # final and errors are never removed from here, as the ResizeRequest is not
+        # going to retry.
+      "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.
+        },
+      ],
+    },
+    "lastAttempt": { # Output only. [Output only] Information about the last attempt to fulfill the request.
+        # The value is temporary since the ResizeRequest can retry, as long as it's
+        # still active and the last attempt value can either be cleared or replaced
+        # with a different error. Since ResizeRequest retries infrequently, the
+        # value may be stale and no longer show an active problem. The value is
+        # cleared when ResizeRequest transitions to the final state (becomes
+        # inactive). If the final state is FAILED the error describing it will be
+        # storred in the "error" field only.
+      "error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled.
+        "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.
+          },
+        ],
+      },
+    },
+  },
+  "zone": "A String", # Output only. [Output Only] The URL of azone
+      # where the resize request is located. Populated only for zonal resize
+      # requests.
+}
+
+ +
+ insert(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None) +
Creates a new Resize Request that starts provisioning VMs immediately
+or queues VM creation.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region
+scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, Name of the managed instance group to which the resize request is scoped.
+Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # InstanceGroupManagerResizeRequest represents a request to create
+    # a number of VMs: either immediately or by queuing the request for the
+    # specified time. This resize request is nested under InstanceGroupManager
+    # and the VMs created by this request are added to the owning
+    # InstanceGroupManager.
+  "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this resize request inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+      # generates this identifier.
+  "kind": "compute#instanceGroupManagerResizeRequest", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for
+      # resize requests.
+  "name": "A String", # The name of this resize request. The name must be 1-63 characters
+      # long, and comply withRFC1035.
+  "region": "A String", # Output only. [Output Only] The URL of aregion
+      # where the resize request is located. Populated only for regional resize
+      # requests.
+  "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request.
+      # At the end of the run duration instance will be deleted.
+      # 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
+  },
+  "resizeBy": 42, # The number of instances to be created by this resize request. The group's
+      # target size will be increased by this number. This field cannot be used
+      # together with 'instances'.
+  "selfLink": "A String", # Output only. [Output Only] The URL for this resize request. The server defines
+      # this URL.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "state": "A String", # Output only. [Output only] Current state of the request.
+  "status": { # Output only. [Output only] Status of the request.
+    "error": { # Output only. [Output only] Fatal errors encountered during the queueing or
+        # provisioning phases of the ResizeRequest that caused the transition to
+        # the FAILED state. Contrary to the last_attempt errors, this field is
+        # final and errors are never removed from here, as the ResizeRequest is not
+        # going to retry.
+      "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.
+        },
+      ],
+    },
+    "lastAttempt": { # Output only. [Output only] Information about the last attempt to fulfill the request.
+        # The value is temporary since the ResizeRequest can retry, as long as it's
+        # still active and the last attempt value can either be cleared or replaced
+        # with a different error. Since ResizeRequest retries infrequently, the
+        # value may be stale and no longer show an active problem. The value is
+        # cleared when ResizeRequest transitions to the final state (becomes
+        # inactive). If the final state is FAILED the error describing it will be
+        # storred in the "error" field only.
+      "error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled.
+        "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.
+          },
+        ],
+      },
+    },
+  },
+  "zone": "A String", # Output only. [Output Only] The URL of azone
+      # where the resize request is located. Populated only for zonal resize
+      # requests.
+}
+
+  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, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves a list of Resize Requests that are contained in the
+managed instance group.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region
+scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group. The name should conform to RFC1035. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String",
+  "id": "A String", # Output only. [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of Resize Request resources.
+    { # InstanceGroupManagerResizeRequest represents a request to create
+        # a number of VMs: either immediately or by queuing the request for the
+        # specified time. This resize request is nested under InstanceGroupManager
+        # and the VMs created by this request are added to the owning
+        # InstanceGroupManager.
+      "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this resize request inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource.
+      "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+          # generates this identifier.
+      "kind": "compute#instanceGroupManagerResizeRequest", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for
+          # resize requests.
+      "name": "A String", # The name of this resize request. The name must be 1-63 characters
+          # long, and comply withRFC1035.
+      "region": "A String", # Output only. [Output Only] The URL of aregion
+          # where the resize request is located. Populated only for regional resize
+          # requests.
+      "requestedRunDuration": { # A Duration represents a fixed-length span of time represented # Requested run duration for instances that will be created by this request.
+          # At the end of the run duration instance will be deleted.
+          # 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
+      },
+      "resizeBy": 42, # The number of instances to be created by this resize request. The group's
+          # target size will be increased by this number. This field cannot be used
+          # together with 'instances'.
+      "selfLink": "A String", # Output only. [Output Only] The URL for this resize request. The server defines
+          # this URL.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+      "state": "A String", # Output only. [Output only] Current state of the request.
+      "status": { # Output only. [Output only] Status of the request.
+        "error": { # Output only. [Output only] Fatal errors encountered during the queueing or
+            # provisioning phases of the ResizeRequest that caused the transition to
+            # the FAILED state. Contrary to the last_attempt errors, this field is
+            # final and errors are never removed from here, as the ResizeRequest is not
+            # going to retry.
+          "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.
+            },
+          ],
+        },
+        "lastAttempt": { # Output only. [Output only] Information about the last attempt to fulfill the request.
+            # The value is temporary since the ResizeRequest can retry, as long as it's
+            # still active and the last attempt value can either be cleared or replaced
+            # with a different error. Since ResizeRequest retries infrequently, the
+            # value may be stale and no longer show an active problem. The value is
+            # cleared when ResizeRequest transitions to the final state (becomes
+            # inactive). If the final state is FAILED the error describing it will be
+            # storred in the "error" field only.
+          "error": { # Output only. Errors that prevented the ResizeRequest to be fulfilled.
+            "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.
+              },
+            ],
+          },
+        },
+      },
+      "zone": "A String", # Output only. [Output Only] The URL of azone
+          # where the resize request is located. Populated only for zonal resize
+          # requests.
+    },
+  ],
+  "kind": "compute#regionInstanceGroupManagerResizeRequestList", # Output only. [Output Only] Type of the resource. Alwayscompute#regionInstanceGroupManagerResizeRequestList for
+      # a list of Resize Requests.
+  "nextPageToken": "A String", # Output only. [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.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # Output only. [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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html index b59ae1421f..d7cd946d33 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html @@ -2591,6 +2591,45 @@

Method Details

# operation. Timestamp is in RFC3339 text format. }, }, + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + # in this managed instance group that have the status. Currently only shown + # for TPU MIGs + # instance group that have the status. For more information about how to + # interpret each status check the instance lifecycle documentation. + # Currently only shown for TPU MIGs. + "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have DEPROVISIONING status. + "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + # have been deleted. Includes only instances that would be shown in the + # listManagedInstances method and not all instances that have been + # deleted in the lifetime of the MIG. + # Does not include FlexStart instances that are waiting for the resources + # availability, they are considered as 'pending'. + "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING status, that is FlexStart instances that are waiting + # for resources. Instances that do not exist because of the other reasons + # are counted as 'non_existent'. + "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING_STOP status. + "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PROVISIONING status. + "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have REPAIRING status. + "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have RUNNING status. + "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STAGING status. + "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPED status. + "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPING status. + "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDED status. + "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDING status. + "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have TERMINATED status. + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -3307,6 +3346,45 @@

Method Details

# operation. Timestamp is in RFC3339 text format. }, }, + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + # in this managed instance group that have the status. Currently only shown + # for TPU MIGs + # instance group that have the status. For more information about how to + # interpret each status check the instance lifecycle documentation. + # Currently only shown for TPU MIGs. + "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have DEPROVISIONING status. + "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + # have been deleted. Includes only instances that would be shown in the + # listManagedInstances method and not all instances that have been + # deleted in the lifetime of the MIG. + # Does not include FlexStart instances that are waiting for the resources + # availability, they are considered as 'pending'. + "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING status, that is FlexStart instances that are waiting + # for resources. Instances that do not exist because of the other reasons + # are counted as 'non_existent'. + "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING_STOP status. + "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PROVISIONING status. + "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have REPAIRING status. + "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have RUNNING status. + "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STAGING status. + "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPED status. + "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPING status. + "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDED status. + "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDING status. + "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have TERMINATED status. + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -4391,6 +4469,45 @@

Method Details

# operation. Timestamp is in RFC3339 text format. }, }, + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + # in this managed instance group that have the status. Currently only shown + # for TPU MIGs + # instance group that have the status. For more information about how to + # interpret each status check the instance lifecycle documentation. + # Currently only shown for TPU MIGs. + "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have DEPROVISIONING status. + "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + # have been deleted. Includes only instances that would be shown in the + # listManagedInstances method and not all instances that have been + # deleted in the lifetime of the MIG. + # Does not include FlexStart instances that are waiting for the resources + # availability, they are considered as 'pending'. + "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING status, that is FlexStart instances that are waiting + # for resources. Instances that do not exist because of the other reasons + # are counted as 'non_existent'. + "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING_STOP status. + "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PROVISIONING status. + "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have REPAIRING status. + "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have RUNNING status. + "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STAGING status. + "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPED status. + "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPING status. + "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDED status. + "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDING status. + "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have TERMINATED status. + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -5917,6 +6034,45 @@

Method Details

# operation. Timestamp is in RFC3339 text format. }, }, + "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances + # in this managed instance group that have the status. Currently only shown + # for TPU MIGs + # instance group that have the status. For more information about how to + # interpret each status check the instance lifecycle documentation. + # Currently only shown for TPU MIGs. + "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have DEPROVISIONING status. + "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or + # have been deleted. Includes only instances that would be shown in the + # listManagedInstances method and not all instances that have been + # deleted in the lifetime of the MIG. + # Does not include FlexStart instances that are waiting for the resources + # availability, they are considered as 'pending'. + "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING status, that is FlexStart instances that are waiting + # for resources. Instances that do not exist because of the other reasons + # are counted as 'non_existent'. + "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PENDING_STOP status. + "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have PROVISIONING status. + "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have REPAIRING status. + "running": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have RUNNING status. + "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STAGING status. + "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPED status. + "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have STOPPING status. + "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDED status. + "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have SUSPENDING status. + "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group + # that have TERMINATED status. + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html index 7fe8b56fb1..06c8b05462 100644 --- a/docs/dyn/compute_v1.regionInstanceTemplates.html +++ b/docs/dyn/compute_v1.regionInstanceTemplates.html @@ -81,13 +81,13 @@

Instance Methods

delete(project, region, instanceTemplate, requestId=None, x__xgafv=None)

Deletes the specified instance template. Deleting an instance template is

- get(project, region, instanceTemplate, x__xgafv=None)

+ get(project, region, instanceTemplate, view=None, x__xgafv=None)

Returns the specified instance template.

insert(project, region, body=None, requestId=None, x__xgafv=None)

Creates an instance template in the specified project and region using the

- list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)

Retrieves a list of instance templates that are contained within the

list_next()

@@ -393,13 +393,18 @@

Method Details

- get(project, region, instanceTemplate, x__xgafv=None) + get(project, region, instanceTemplate, view=None, x__xgafv=None)
Returns the specified instance template.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, The name of the region for this request. (required)
   instanceTemplate: string, The name of the instance template. (required)
+  view: string, View of the instance template.
+    Allowed values
+      BASIC - Include everything except Partner Metadata.
+      FULL - Include everything.
+      INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1146,6 +1151,15 @@ 

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -2097,6 +2111,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. @@ -2584,7 +2607,7 @@

Method Details

- list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)
Retrieves a list of instance templates that are contained within the
 specified project and region.
 
@@ -2674,6 +2697,11 @@ 

Method Details

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. + view: string, View of the instance template. + Allowed values + BASIC - Include everything except Partner Metadata. + FULL - Include everything. + INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -3423,6 +3451,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index be0d9ba8bc..5a3b5735fb 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -1263,6 +1263,15 @@

Method Details

"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. "totalEgressBandwidthTier": "A String", }, + "partnerMetadata": { # Partner Metadata assigned to the instance properties. A map from a + # subdomain (namespace) to entries map. + "a_key": { + "entries": { # Map of a partner metadata that belong to the same subdomain. + # It accepts any value including google.protobuf.Struct. + "a_key": "", + }, + }, + }, "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. # If not specified, use INHERIT_FROM_SUBNETWORK as default. # Note that for MachineImage, this is not supported yet. diff --git a/docs/dyn/compute_v1.reservations.html b/docs/dyn/compute_v1.reservations.html index b492530c7b..3fbc4b5aa4 100644 --- a/docs/dyn/compute_v1.reservations.html +++ b/docs/dyn/compute_v1.reservations.html @@ -267,6 +267,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -887,6 +888,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -1494,6 +1496,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -2108,6 +2111,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will @@ -3908,6 +3912,7 @@

Method Details

}, "commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field # displays for reservations that are tied to a commitment. + "confidentialComputeType": "A String", "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will diff --git a/docs/dyn/compute_v1.zoneVmExtensionPolicies.html b/docs/dyn/compute_v1.zoneVmExtensionPolicies.html new file mode 100644 index 0000000000..880626a31d --- /dev/null +++ b/docs/dyn/compute_v1.zoneVmExtensionPolicies.html @@ -0,0 +1,1401 @@ + + + +

Compute Engine API . zoneVmExtensionPolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, zone, vmExtensionPolicy, requestId=None, x__xgafv=None)

+

Deletes a specified zone VM extension policy.

+

+ get(project, zone, vmExtensionPolicy, x__xgafv=None)

+

Retrieves details of a specific zone VM extension policy.

+

+ insert(project, zone, body=None, requestId=None, x__xgafv=None)

+

Creates a new zone-level VM extension policy within a project.

+

+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists all VM extension policies within a specific zone for a project.

+

+ list_next()

+

Retrieves the next page of results.

+

+ update(project, zone, vmExtensionPolicy, body=None, requestId=None, x__xgafv=None)

+

Modifies an existing zone VM extension policy.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, zone, vmExtensionPolicy, requestId=None, x__xgafv=None) +
Deletes a specified zone VM extension policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the zone VM extension policy 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, zone, vmExtensionPolicy, x__xgafv=None) +
Retrieves details of a specific zone VM extension policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the VM extension policy 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 VM extension policy.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+      # policy configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+  "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.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the most recent creation timestamp takes precedence.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+ +
+ insert(project, zone, body=None, requestId=None, x__xgafv=None) +
Creates a new zone-level VM extension policy within a project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a VM extension policy.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+      # policy configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+  "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.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the most recent creation timestamp takes precedence.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+  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, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists all VM extension policies within a specific zone for a project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String", # Output only. [Output Only] 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 VmExtensionPolicy. An up-to-date
+      # fingerprint must be provided in order to update the VmExtensionPolicy.
+      #
+      # To see the latest value of the fingerprint, make a get() request to
+      # retrieve a VmExtensionPolicy.
+  "id": "A String", # Output only. [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # Output only. [Output Only] A list of VM extension policy resources.
+    { # Represents a VM extension policy.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource.
+      "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+          # policy configurations.
+        "a_key": { # Configuration for a specific VM extension.
+          "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+              # version is used.
+          "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+        },
+      },
+      "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+          # applicable.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+          # *any* of the provided selectors (logical OR). If this list is empty, the
+          # policy applies to all VMs.
+        { # Defines how to select VMs to apply a zone VM extension policy.
+          "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+              # labels.
+            "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+                # VMs must have all of the labels specified in this map to be selected
+                # (logical AND).
+                #
+                # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+                # "value2")}, the VM labels must contain both ("key1", "value1") and
+                # ("key2", "value2") to be selected. If the VM labels are ("key1",
+                # "value1") and ("something", "else"), it will not be selected.
+                #
+                # If the map is empty, it's considered a match.
+              "a_key": "A String",
+            },
+          },
+        },
+      ],
+      "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+      "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+      "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.
+      "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+          # apply to the same extension.
+          # The policy priority is an integer from 0 to 65535, inclusive. Lower
+          # integers indicate higher priorities. If you do not specify a priority when
+          # creating a rule, it is assigned a priority of 1000. If priorities are
+          # equal, the policy with the most recent creation timestamp takes precedence.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+      "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+      "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+          # text format.
+    },
+  ],
+  "kind": "compute#vmExtensionPolicyList", # Output only. Type of resource.
+  "nextPageToken": "A String", # Output only. [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. [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.
+        
+
+ +
+ update(project, zone, vmExtensionPolicy, body=None, requestId=None, x__xgafv=None) +
Modifies an existing zone VM extension policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the zone VM extension policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a VM extension policy.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+      # policy configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+  "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.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the most recent creation timestamp takes precedence.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+  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.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 8eadb400b8..22751f8768 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -54676,7 +54676,7 @@ } } }, -"revision": "20260227", +"revision": "20260306", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -59092,18 +59092,6 @@ false }, "readOnly": true, "type": "array" -}, -"vpcNetworkScope": { -"description": "The network scope of the backends that can be added to the backend\nservice. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.\n\nA backend service with the VPC scope set to GLOBAL_VPC_NETWORK\nis only allowed to have backends in global VPC networks.\n\nWhen the VPC scope is set to REGIONAL_VPC_NETWORK the backend\nservice is only allowed to have backends in regional networks in the same\nscope as the backend service.\nNote: if not specified then GLOBAL_VPC_NETWORK will be used.", -"enum": [ -"GLOBAL_VPC_NETWORK", -"REGIONAL_VPC_NETWORK" -], -"enumDescriptions": [ -"The backend service can only have backends in global VPCs", -"The backend service can only have backends in regional VPCs" -], -"type": "string" } }, "type": "object" @@ -61271,6 +61259,10 @@ false "description": "Instance provisining properties.", "id": "CapacityAdviceRequestInstanceProperties", "properties": { +"acceleratorTopology": { +"description": "Input only. Specifies the topology required to create a partition for\nVMs that have interconnected GPUs or TPUs.\nExample values: 2x2 for ct5l-hightpu-4t.", +"type": "string" +}, "scheduling": { "$ref": "CapacityAdviceRequestInstancePropertiesScheduling", "description": "Specifies the scheduling options." @@ -74827,7 +74819,7 @@ false "type": "string" }, "source": { -"description": "The full Google Cloud Storage URL where the raw disk image archive is\nstored.\nThe following are valid formats for the URL:\n \n - https://storage.googleapis.com/bucket_name/image_archive_name\n - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n \n - The rawDisk.source URL \n - The sourceDisk URL \n - The sourceImage URL \n - The sourceSnapshot URL", +"description": "The full Google Cloud Storage URL or Artifact Registry path where the raw\ndisk image archive is stored.\nThe following are valid formats:\n \n - https://storage.googleapis.com/bucket_name/image_archive_name\n - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name\n - projects/project/locations/location/repositories/repo/packages/package/versions/version_id\n - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n \n - The rawDisk.source URL \n - The sourceDisk URL \n - The sourceImage URL \n - The sourceSnapshot URL", "type": "string" } }, @@ -78149,6 +78141,37 @@ false }, "description": "Map of accelerator topologies that should have their state changed to\nthe specified value. The key is the hashed topology locus id. It can be\nobtained from the GetAvailableAcceleratorTopologies rpc.", "type": "object" +}, +"acceleratorTopologyConfigurations": { +"additionalProperties": { +"$ref": "InstanceGroupManagersConfigureAcceleratorTopologiesRequestAcceleratorTopologyConfiguration" +}, +"description": "Map of accelerator topologies that should have their state changed to\nthe specified configuration. The map key is the hashed topology locus id.\nIt can be obtained from the GetAvailableAcceleratorTopologies rpc.", +"type": "object" +} +}, +"type": "object" +}, +"InstanceGroupManagersConfigureAcceleratorTopologiesRequestAcceleratorTopologyConfiguration": { +"description": "Configuration for a single accelerator topology.", +"id": "InstanceGroupManagersConfigureAcceleratorTopologiesRequestAcceleratorTopologyConfiguration", +"properties": { +"action": { +"enum": [ +"ACCELERATOR_TOPOLOGY_ACTION_UNSPECIFIED", +"ACTIVATE", +"DEACTIVATE" +], +"enumDescriptions": [ +"Default value. Should not be used.", +"The accelerator topology is to be activated.", +"The accelerator topology is to be deactivated." +], +"type": "string" +}, +"externalId": { +"description": "Identifier of the accelerator topology assigned externally to\ndifferentiate who is the owner of the topology. The format needs to\nconform to RFC1035 and be unique. The uniqueness is guaranteed by the\nrequestor. If it is provided on activating the sub-slice it will have to\nbe provided on deactivating as well. This identifier is cleared on\nsuccessful deform of a sub-slice.", +"type": "string" } }, "type": "object" @@ -78233,14 +78256,12 @@ false "enum": [ "DEGRADED", "HEALTHY", -"UNHEALTHY", -"UNKNOWN" +"UNHEALTHY" ], "enumDescriptions": [ "All VM are in RUNNING state, but there is an issue with\nthe inter-chip connectivity that makes this part\nof the infrastructure ready to use as a working\ninter-chip connected group only in a degraded mode.\nThis is allowed only for Instances configured with ICI\nresiliency", "All VM are in RUNNING state, there are no issues with the\ninter-chip connectivity.", -"Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group.", -"No signal available" +"Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group." ], "type": "string" }, @@ -78342,6 +78363,10 @@ false "description": "Timestamp when the last error happened", "format": "google-datetime", "type": "string" +}, +"externalId": { +"description": "Identifier of the accelerator topology assigned externally to\ndifferentiate who is the owner of the topology. This is set in\nConfigureAcceleratorTopologies. If it is provided on activating the\nsub-slice it will have to be provided on deactivating as well.\nThis identifier is cleared on successful deform of a sub-slice.", +"type": "string" } }, "type": "object" @@ -78562,6 +78587,10 @@ false "description": "If this flag is true, the managed instance group attempts to create all\ninstances initiated by this resize request only once. If there is an error\nduring creation, the managed instance group does not retry create this\ninstance, and we will decrease the targetSize of the request\ninstead. If the flag is false, the group attempts to recreate each instance\ncontinuously until it succeeds.\n\nThis flag matters only in the first attempt of creation of an instance.\nAfter an instance is successfully created while this flag is enabled, the\ninstance behaves the same way as all the other instances created with a\nregular resize request. In particular, if a running instance dies\nunexpectedly at a later time and needs to be recreated, this mode does not\naffect the recreation behavior in that scenario.\n\nThis flag is applicable only to the current resize request. It does not\ninfluence other resize requests in any way.\n\nYou can see which instances is being creating in which mode by calling\nthe get or listManagedInstances API.", "type": "boolean" }, +"scaleInProtection": { +"description": "If this flag is enabled within a request to decrease a MIG's target size,\nthen the MIG declines that request.", +"type": "boolean" +}, "targetSize": { "description": "The number of running instances that the managed instance group should\nmaintain at any given time. The group automatically adds or removes\ninstances to maintain the number of instances specified by this parameter.", "format": "int32", @@ -99738,6 +99767,24 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"networkTier": { +"description": "Network tier to be used for this prefix. All child delegated prefixes will\ninherit this field. If this field is not specified, it defaults to the\nnetwork tier of the project that the PublicAdvertisedPrefix belongs to.", +"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" +}, "pdpScope": { "description": "Specifies how child public delegated prefix will be scoped. It could\nbe one of following values:\n \n \n - `REGIONAL`: The public delegated prefix is regional only. The\n provisioning will take a few minutes.\n - `GLOBAL`: The public delegated prefix is global only. The\n provisioning will take ~4 weeks.\n - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is\n BYOIP V1 legacy prefix. This is output only value and no longer\n supported in BYOIP V2.", "enum": [ @@ -100085,6 +100132,24 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"networkTier": { +"description": "Network tier of the public delegated prefix. If populated, it must match\nthe network tier of the parent public advertised prefix. If not populated,\nit defaults to the network tier of the parent public advertised prefix.", +"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" +}, "parentPrefix": { "description": "The URL of parent prefix. Either PublicAdvertisedPrefix or\nPublicDelegatedPrefix.", "type": "string" @@ -104089,6 +104154,10 @@ false "description": "If this flag is true, the managed instance group attempts to create all\ninstances initiated by this resize request only once. If there is an error\nduring creation, the managed instance group does not retry create this\ninstance, and we will decrease the targetSize of the request\ninstead. If the flag is false, the group attempts to recreate each instance\ncontinuously until it succeeds.\n\nThis flag matters only in the first attempt of creation of an instance.\nAfter an instance is successfully created while this flag is enabled, the\ninstance behaves the same way as all the other instances created with a\nregular resize request. In particular, if a running instance dies\nunexpectedly at a later time and needs to be recreated, this mode does not\naffect the recreation behavior in that scenario.\n\nThis flag is applicable only to the current resize request. It does not\ninfluence other resize requests in any way.\n\nYou can see which instances ar being created in which mode by calling\nthe get or listManagedInstances API.", "type": "boolean" }, +"scaleInProtection": { +"description": "If this flag is enabled within a request to decrease a MIG's target size,\nthen the MIG declines that request.", +"type": "boolean" +}, "targetSize": { "description": "The number of running instances that the managed instance group should\nmaintain at any given time. The group automatically adds or removes\ninstances to maintain the number of instances specified by this parameter.", "format": "int32", @@ -108449,6 +108518,16 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"pauseTime": { +"description": "Output only. The timestamp at which the Rollout was paused.", +"readOnly": true, +"type": "string" +}, +"resumeTime": { +"description": "Output only. The timestamp at which the Rollout was resumed.", +"readOnly": true, +"type": "string" +}, "rolloutEntity": { "$ref": "RolloutRolloutEntity", "description": "Required. The resource being rolled out." @@ -120227,6 +120306,23 @@ false "description": "The range of IP addresses belonging to this subnetwork secondary range.\nProvide this property when you create the subnetwork. Ranges must be\nunique and non-overlapping with all primary and secondary IP ranges\nwithin a network. Both IPv4 and IPv6 ranges are supported. For IPv4,\nthe range can be any range listed in theValid\nranges list.\n\nFor IPv6:\nThe range must have a /64 prefix length.\nThe range must be omitted, for auto-allocation from Google-defined ULA\nIPv6 range.\nFor BYOGUA internal IPv6 secondary range, the range may be specified\nalong with the `ipCollection` field.\nIf an `ipCollection` is specified, the requested ip_cidr_range must lie\nwithin the range of the PDP referenced by the `ipCollection` field for\nallocation.\nIf `ipCollection` field is specified, but ip_cidr_range is not,\nthe range is auto-allocated from the PDP referenced by the `ipCollection`\nfield.", "type": "string" }, +"ipCollection": { +"description": "Reference to a Public Delegated Prefix (PDP) for BYOIP.\nThis field should be specified for configuring BYOGUA internal IPv6\nsecondary range.\nWhen specified along with the ip_cidr_range, the ip_cidr_range must lie\nwithin the PDP referenced by the `ipCollection` field.\nWhen specified without the ip_cidr_range, the range is auto-allocated\nfrom the PDP referenced by the `ipCollection` field.", +"type": "string" +}, +"ipVersion": { +"enum": [ +"IPV4", +"IPV6", +"IP_VERSION_UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"Treated as IPV4 for backward-compatibility." +], +"type": "string" +}, "rangeName": { "description": "The name associated with this subnetwork secondary range, used when adding\nan alias IP/IPv6 range to a VM instance.\nThe name must be 1-63 characters long, and comply withRFC1035.\nThe name must be unique within the subnetwork.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index aefd558cbd..61566be0a5 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -51297,7 +51297,7 @@ } } }, -"revision": "20260227", +"revision": "20260306", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -63438,6 +63438,17 @@ false "$ref": "FutureReservationCommitmentInfo", "description": "If not present, then FR will not deliver a new commitment or update an\nexisting commitment." }, +"confidentialComputeType": { +"enum": [ +"CONFIDENTIAL_COMPUTE_TYPE_TDX", +"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED" +], +"enumDescriptions": [ +"Intel Trust Domain Extensions.", +"" +], +"type": "string" +}, "creationTimestamp": { "description": "Output only. [Output Only] The creation timestamp for this future reservation inRFC3339\ntext format.", "readOnly": true, @@ -68941,7 +68952,7 @@ false "type": "string" }, "source": { -"description": "The full Google Cloud Storage URL where the raw disk image archive is\nstored.\nThe following are valid formats for the URL:\n \n - https://storage.googleapis.com/bucket_name/image_archive_name\n - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n \n - The rawDisk.source URL \n - The sourceDisk URL \n - The sourceImage URL \n - The sourceSnapshot URL", +"description": "The full Google Cloud Storage URL or Artifact Registry path where the raw\ndisk image archive is stored.\nThe following are valid formats:\n \n - https://storage.googleapis.com/bucket_name/image_archive_name\n - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name\n - projects/project/locations/location/repositories/repo/packages/package/versions/version_id\n - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n \n - The rawDisk.source URL \n - The sourceDisk URL \n - The sourceImage URL \n - The sourceSnapshot URL", "type": "string" } }, @@ -72039,6 +72050,37 @@ false }, "description": "Map of accelerator topologies that should have their state changed to\nthe specified value. The key is the hashed topology locus id. It can be\nobtained from the GetAvailableAcceleratorTopologies rpc.", "type": "object" +}, +"acceleratorTopologyConfigurations": { +"additionalProperties": { +"$ref": "InstanceGroupManagersConfigureAcceleratorTopologiesRequestAcceleratorTopologyConfiguration" +}, +"description": "Map of accelerator topologies that should have their state changed to\nthe specified configuration. The map key is the hashed topology locus id.\nIt can be obtained from the GetAvailableAcceleratorTopologies rpc.", +"type": "object" +} +}, +"type": "object" +}, +"InstanceGroupManagersConfigureAcceleratorTopologiesRequestAcceleratorTopologyConfiguration": { +"description": "Configuration for a single accelerator topology.", +"id": "InstanceGroupManagersConfigureAcceleratorTopologiesRequestAcceleratorTopologyConfiguration", +"properties": { +"action": { +"enum": [ +"ACCELERATOR_TOPOLOGY_ACTION_UNSPECIFIED", +"ACTIVATE", +"DEACTIVATE" +], +"enumDescriptions": [ +"Default value. Should not be used.", +"The accelerator topology is to be activated.", +"The accelerator topology is to be deactivated." +], +"type": "string" +}, +"externalId": { +"description": "Identifier of the accelerator topology assigned externally to\ndifferentiate who is the owner of the topology. The format needs to\nconform to RFC1035 and be unique. The uniqueness is guaranteed by the\nrequestor. If it is provided on activating the sub-slice it will have to\nbe provided on deactivating as well. This identifier is cleared on\nsuccessful deform of a sub-slice.", +"type": "string" } }, "type": "object" @@ -72116,14 +72158,12 @@ false "enum": [ "DEGRADED", "HEALTHY", -"UNHEALTHY", -"UNKNOWN" +"UNHEALTHY" ], "enumDescriptions": [ "All VM are in RUNNING state, but there is an issue with\nthe inter-chip connectivity that makes this part\nof the infrastructure ready to use as a working\ninter-chip connected group only in a degraded mode.\nThis is allowed only for Instances configured with ICI\nresiliency", "All VM are in RUNNING state, there are no issues with the\ninter-chip connectivity.", -"Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group.", -"No signal available" +"Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group." ], "type": "string" }, @@ -72225,6 +72265,10 @@ false "description": "Timestamp when the last error happened", "format": "google-datetime", "type": "string" +}, +"externalId": { +"description": "Identifier of the accelerator topology assigned externally to\ndifferentiate who is the owner of the topology. This is set in\nConfigureAcceleratorTopologies. If it is provided on activating the\nsub-slice it will have to be provided on deactivating as well.\nThis identifier is cleared on successful deform of a sub-slice.", +"type": "string" } }, "type": "object" @@ -95288,6 +95332,17 @@ false "readOnly": true, "type": "string" }, +"confidentialComputeType": { +"enum": [ +"CONFIDENTIAL_COMPUTE_TYPE_TDX", +"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED" +], +"enumDescriptions": [ +"Intel Trust Domain Extensions.", +"" +], +"type": "string" +}, "creationTimestamp": { "description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index cdce0892a7..b1c94dfc25 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -10747,6 +10747,21 @@ "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" +}, +"view": { +"description": "View of the instance template.", +"enum": [ +"BASIC", +"FULL", +"INSTANCE_VIEW_UNSPECIFIED" +], +"enumDescriptions": [ +"Include everything except Partner Metadata.", +"Include everything.", +"The default / unset value. The API will default to the BASIC view." +], +"location": "query", +"type": "string" } }, "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", @@ -10877,6 +10892,21 @@ "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" +}, +"view": { +"description": "View of the instance template.", +"enum": [ +"BASIC", +"FULL", +"INSTANCE_VIEW_UNSPECIFIED" +], +"enumDescriptions": [ +"Include everything except Partner Metadata.", +"Include everything.", +"The default / unset value. The API will default to the BASIC view." +], +"location": "query", +"type": "string" } }, "path": "projects/{project}/global/instanceTemplates", @@ -11527,6 +11557,21 @@ "required": true, "type": "string" }, +"view": { +"description": "View of the instance.", +"enum": [ +"BASIC", +"FULL", +"INSTANCE_VIEW_UNSPECIFIED" +], +"enumDescriptions": [ +"Include everything except Partner Metadata.", +"Include everything.", +"The default / unset value. The API will default to the BASIC view." +], +"location": "query", +"type": "string" +}, "zone": { "description": "The name of the zone for this request.", "location": "path", @@ -11697,6 +11742,54 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getPartnerMetadata": { +"description": "Gets partner metadata of the specified instance and namespaces.", +"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata", +"httpMethod": "GET", +"id": "compute.instances.getPartnerMetadata", +"parameterOrder": [ +"project", +"zone", +"instance" +], +"parameters": { +"instance": { +"description": "Name of the instance scoping 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" +}, +"namespaces": { +"description": "Comma separated partner metadata namespaces.", +"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" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata", +"response": { +"$ref": "PartnerMetadata" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getScreenshot": { "description": "Returns the screenshot from the specified instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/screenshot", @@ -11938,6 +12031,21 @@ "location": "query", "type": "boolean" }, +"view": { +"description": "View of the instance.", +"enum": [ +"BASIC", +"FULL", +"INSTANCE_VIEW_UNSPECIFIED" +], +"enumDescriptions": [ +"Include everything except Partner Metadata.", +"Include everything.", +"The default / unset value. The API will default to the BASIC view." +], +"location": "query", +"type": "string" +}, "zone": { "description": "The name of the zone for this request.", "location": "path", @@ -12027,6 +12135,56 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"patchPartnerMetadata": { +"description": "Patches partner metadata of the specified instance.", +"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata", +"httpMethod": "POST", +"id": "compute.instances.patchPartnerMetadata", +"parameterOrder": [ +"project", +"zone", +"instance" +], +"parameters": { +"instance": { +"description": "Name of the instance scoping 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" +}, +"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" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata", +"request": { +"$ref": "PartnerMetadata" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "performMaintenance": { "description": "Perform a manual maintenance on the instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance", @@ -26972,21 +27130,22 @@ } } }, -"regionInstanceGroupManagers": { +"regionInstanceGroupManagerResizeRequests": { "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", +"cancel": { +"description": "Cancels the specified resize request.\nCancelled resize request no longer waits for the resources to be\nprovisioned. Cancel is only possible for requests that are in accepted\nstate.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", "httpMethod": "POST", -"id": "compute.regionInstanceGroupManagers.abandonInstances", +"id": "compute.regionInstanceGroupManagerResizeRequests.cancel", "parameterOrder": [ "project", "region", -"instanceGroupManager" +"instanceGroupManager", +"resizeRequest" ], "parameters": { "instanceGroupManager": { -"description": "Name of the managed instance group.", +"description": "The name of the managed instance group.\nName should conform to RFC1035 or be a resource ID.", "location": "path", "required": true, "type": "string" @@ -26999,7 +27158,7 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "The name of the region\nscoping this request. Name should conform to RFC1035.", "location": "path", "required": true, "type": "string" @@ -27008,12 +27167,15 @@ "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" +"resizeRequest": { +"description": "The name of the resize request to cancel.\nName should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +} }, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", "response": { "$ref": "Operation" }, @@ -27022,19 +27184,20 @@ "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", +"delete": { +"description": "Deletes the specified, inactive resize request. Requests that are still\nactive cannot be deleted. Deleting request does not delete instances that\nwere provisioned previously.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"httpMethod": "DELETE", +"id": "compute.regionInstanceGroupManagerResizeRequests.delete", "parameterOrder": [ "project", "region", -"instanceGroupManager" +"instanceGroupManager", +"resizeRequest" ], "parameters": { "instanceGroupManager": { -"description": "The name of the managed instance group, should conform to RFC1035.", +"description": "The name of the managed instance group.\nName should conform to RFC1035 or be a resource ID.", "location": "path", "required": true, "type": "string" @@ -27047,16 +27210,24 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request, should conform to RFC1035.", +"description": "The name of the region\nscoping this request. Name should conform to RFC1035.", "location": "path", "required": true, "type": "string" -} }, -"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", -"request": { -"$ref": "RegionInstanceGroupManagersApplyUpdatesRequest" +"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" +}, +"resizeRequest": { +"description": "The name of the resize request to delete.\nName should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +} }, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", "response": { "$ref": "Operation" }, @@ -27065,11 +27236,59 @@ "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", +"get": { +"description": "Returns all of the details about the specified resize request.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"httpMethod": "GET", +"id": "compute.regionInstanceGroupManagerResizeRequests.get", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager", +"resizeRequest" +], +"parameters": { +"instanceGroupManager": { +"description": "The name of the managed instance group.\nName should conform to RFC1035 or be a resource ID.", +"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 the region\nscoping this request. Name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"resizeRequest": { +"description": "The name of the resize request.\nName should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"response": { +"$ref": "InstanceGroupManagerResizeRequest" +}, +"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 new Resize Request that starts provisioning VMs immediately\nor queues VM creation.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", "httpMethod": "POST", -"id": "compute.regionInstanceGroupManagers.createInstances", +"id": "compute.regionInstanceGroupManagerResizeRequests.insert", "parameterOrder": [ "project", "region", @@ -27077,7 +27296,7 @@ ], "parameters": { "instanceGroupManager": { -"description": "The name of the managed instance group.\nIt should conform to RFC1035.", +"description": "Name of the managed instance group to which the resize request is scoped.\nName should conform to RFC1035 or be a resource ID.", "location": "path", "required": true, "type": "string" @@ -27090,20 +27309,20 @@ "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\nscoping this request. Name 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).", +"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}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", "request": { -"$ref": "RegionInstanceGroupManagersCreateInstancesRequest" +"$ref": "InstanceGroupManagerResizeRequest" }, "response": { "$ref": "Operation" @@ -27113,23 +27332,46 @@ "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": "Retrieves a list of Resize Requests that are contained in the\nmanaged instance group.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", +"httpMethod": "GET", +"id": "compute.regionInstanceGroupManagerResizeRequests.list", "parameterOrder": [ "project", "region", "instanceGroupManager" ], "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" +}, "instanceGroupManager": { -"description": "Name of the managed instance group to delete.", +"description": "The name of the managed instance group. The name should conform to RFC1035.", "location": "path", "required": true, "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", @@ -27138,31 +27380,220 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region\nscoping this request. Name 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. 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}/instanceGroupManagers/{instanceGroupManager}", +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", "response": { -"$ref": "Operation" +"$ref": "RegionInstanceGroupManagerResizeRequestsListResponse" }, "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" ] +} +} }, -"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", +"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.deleteInstances", +"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", @@ -28489,6 +28920,21 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" +}, +"view": { +"description": "View of the instance template.", +"enum": [ +"BASIC", +"FULL", +"INSTANCE_VIEW_UNSPECIFIED" +], +"enumDescriptions": [ +"Include everything except Partner Metadata.", +"Include everything.", +"The default / unset value. The API will default to the BASIC view." +], +"location": "query", +"type": "string" } }, "path": "projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}", @@ -28594,6 +29040,21 @@ "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" +}, +"view": { +"description": "View of the instance template.", +"enum": [ +"BASIC", +"FULL", +"INSTANCE_VIEW_UNSPECIFIED" +], +"enumDescriptions": [ +"Include everything except Partner Metadata.", +"Include everything.", +"The default / unset value. The API will default to the BASIC view." +], +"location": "query", +"type": "string" } }, "path": "projects/{project}/regions/{region}/instanceTemplates", @@ -44378,6 +44839,253 @@ } } }, +"zoneVmExtensionPolicies": { +"methods": { +"delete": { +"description": "Deletes a specified zone VM extension policy.", +"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"httpMethod": "DELETE", +"id": "compute.zoneVmExtensionPolicies.delete", +"parameterOrder": [ +"project", +"zone", +"vmExtensionPolicy" +], +"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" +}, +"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" +}, +"vmExtensionPolicy": { +"description": "Name of the zone VM extension policy to delete.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Retrieves details of a specific zone VM extension policy.", +"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"httpMethod": "GET", +"id": "compute.zoneVmExtensionPolicies.get", +"parameterOrder": [ +"project", +"zone", +"vmExtensionPolicy" +], +"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" +}, +"vmExtensionPolicy": { +"description": "Name of the VM extension policy 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" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"response": { +"$ref": "VmExtensionPolicy" +}, +"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 new zone-level VM extension policy within a project.", +"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies", +"httpMethod": "POST", +"id": "compute.zoneVmExtensionPolicies.insert", +"parameterOrder": [ +"project", +"zone" +], +"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" +}, +"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" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/vmExtensionPolicies", +"request": { +"$ref": "VmExtensionPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Lists all VM extension policies within a specific zone for a project.", +"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies", +"httpMethod": "GET", +"id": "compute.zoneVmExtensionPolicies.list", +"parameterOrder": [ +"project", +"zone" +], +"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" +}, +"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" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/vmExtensionPolicies", +"response": { +"$ref": "VmExtensionPolicyList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"update": { +"description": "Modifies an existing zone VM extension policy.", +"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"httpMethod": "PATCH", +"id": "compute.zoneVmExtensionPolicies.update", +"parameterOrder": [ +"project", +"zone", +"vmExtensionPolicy" +], +"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" +}, +"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" +}, +"vmExtensionPolicy": { +"description": "Name of the zone VM extension policy to update.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"request": { +"$ref": "VmExtensionPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "zones": { "methods": { "get": { @@ -44473,7 +45181,7 @@ } } }, -"revision": "20260227", +"revision": "20260306", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -55655,6 +56363,17 @@ false "$ref": "FutureReservationCommitmentInfo", "description": "If not present, then FR will not deliver a new commitment or update an\nexisting commitment." }, +"confidentialComputeType": { +"enum": [ +"CONFIDENTIAL_COMPUTE_TYPE_TDX", +"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED" +], +"enumDescriptions": [ +"Intel Trust Domain Extensions.", +"" +], +"type": "string" +}, "creationTimestamp": { "description": "Output only. [Output Only] The creation timestamp for this future reservation inRFC3339\ntext format.", "readOnly": true, @@ -60655,7 +61374,7 @@ false "type": "string" }, "source": { -"description": "The full Google Cloud Storage URL where the raw disk image archive is\nstored.\nThe following are valid formats for the URL:\n \n - https://storage.googleapis.com/bucket_name/image_archive_name\n - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n \n - The rawDisk.source URL \n - The sourceDisk URL \n - The sourceImage URL \n - The sourceSnapshot URL", +"description": "The full Google Cloud Storage URL or Artifact Registry path where the raw\ndisk image archive is stored.\nThe following are valid formats:\n \n - https://storage.googleapis.com/bucket_name/image_archive_name\n - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name\n - projects/project/locations/location/repositories/repo/packages/package/versions/version_id\n - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n \n - The rawDisk.source URL \n - The sourceDisk URL \n - The sourceImage URL \n - The sourceSnapshot URL", "type": "string" } }, @@ -61123,6 +61842,13 @@ false "$ref": "InstanceParams", "description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." }, +"partnerMetadata": { +"additionalProperties": { +"$ref": "StructuredEntries" +}, +"description": "Partner Metadata assigned to the instance. A map from a subdomain\n(namespace) to entries map.", +"type": "object" +}, "privateIpv6GoogleAccess": { "description": "The private IPv6 google access type for the VM.\nIf not specified, use INHERIT_FROM_SUBNETWORK as default.", "enum": [ @@ -62645,6 +63371,11 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"region": { +"description": "Output only. [Output Only] The URL of aregion\nwhere the resize request is located. Populated only for regional resize\nrequests.", +"readOnly": true, +"type": "string" +}, "requestedRunDuration": { "$ref": "Duration", "description": "Requested run duration for instances that will be created by this request.\nAt the end of the run duration instance will be deleted." @@ -63032,6 +63763,11 @@ false "description": "Output only. [Output Only] The status of bulk instance operation.", "readOnly": true }, +"currentInstanceStatuses": { +"$ref": "InstanceGroupManagerStatusInstanceStatusSummary", +"description": "Output only. [Output Only] The list of instance statuses and the number of instances\nin this managed instance group that have the status. Currently only shown\nfor TPU MIGs", +"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, @@ -63242,6 +63978,91 @@ false }, "type": "object" }, +"InstanceGroupManagerStatusInstanceStatusSummary": { +"description": "The list of instance statuses and the number of instances in this managed\ninstance group that have the status. For more information about how to\ninterpret each status check the instance lifecycle documentation.\nCurrently only shown for TPU MIGs.", +"id": "InstanceGroupManagerStatusInstanceStatusSummary", +"properties": { +"deprovisioning": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have DEPROVISIONING status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"nonExistent": { +"description": "Output only. [Output Only] The number of instances that have not been created yet or\nhave been deleted. Includes only instances that would be shown in the\nlistManagedInstances method and not all instances that have been\ndeleted in the lifetime of the MIG.\nDoes not include FlexStart instances that are waiting for the resources\navailability, they are considered as 'pending'.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"pending": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have PENDING status, that is FlexStart instances that are waiting\nfor resources. Instances that do not exist because of the other reasons\nare counted as 'non_existent'.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"pendingStop": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have PENDING_STOP status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"provisioning": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have PROVISIONING status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"repairing": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have REPAIRING status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"running": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have RUNNING status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"staging": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have STAGING status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"stopped": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have STOPPED status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"stopping": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have STOPPING status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"suspended": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have SUSPENDED status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"suspending": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have SUSPENDING status.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"terminated": { +"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have TERMINATED status.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "InstanceGroupManagerStatusStateful": { "id": "InstanceGroupManagerStatusStateful", "properties": { @@ -64834,6 +65655,13 @@ false "$ref": "NetworkPerformanceConfig", "description": "Note that for MachineImage, this is not supported yet." }, +"partnerMetadata": { +"additionalProperties": { +"$ref": "StructuredEntries" +}, +"description": "Partner Metadata assigned to the instance properties. A map from a\nsubdomain (namespace) to entries map.", +"type": "object" +}, "privateIpv6GoogleAccess": { "description": "The private IPv6 google access type for VMs.\nIf not specified, use INHERIT_FROM_SUBNETWORK as default.\nNote that for MachineImage, this is not supported yet.", "enum": [ @@ -80132,6 +80960,25 @@ false }, "type": "object" }, +"PartnerMetadata": { +"description": "Model definition of partner_metadata field.\nTo be used in dedicated Partner Metadata methods and to be inlined in\nthe Instance and InstanceTemplate resources.", +"id": "PartnerMetadata", +"properties": { +"fingerprint": { +"description": "Instance-level hash to be used for optimistic\nlocking.", +"format": "byte", +"type": "string" +}, +"partnerMetadata": { +"additionalProperties": { +"$ref": "StructuredEntries" +}, +"description": "Partner Metadata assigned to the instance. A map from a subdomain to\nentries map. Subdomain name must be compliant withRFC1035\ndefinition. The total size of all keys and values must be less than 2MB.\nSubdomain 'metadata.compute.googleapis.com' is reserverd for instance's\nmetadata.", +"type": "object" +} +}, +"type": "object" +}, "PathMatcher": { "description": "A matcher for the path portion of the URL. The BackendService\nfrom the longest-matched rule will serve the URL. If no rule was matched, the\ndefault service is used.", "id": "PathMatcher", @@ -83265,6 +84112,176 @@ false }, "type": "object" }, +"RegionInstanceGroupManagerResizeRequestsListResponse": { +"id": "RegionInstanceGroupManagerResizeRequestsListResponse", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.", +"readOnly": true, +"type": "string" +}, +"items": { +"description": "A list of Resize Request resources.", +"items": { +"$ref": "InstanceGroupManagerResizeRequest" +}, +"type": "array" +}, +"kind": { +"default": "compute#regionInstanceGroupManagerResizeRequestList", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#regionInstanceGroupManagerResizeRequestList for\na list of Resize Requests.", +"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" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "Output only. [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" +} +}, +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "RegionInstanceGroupManagerUpdateInstanceConfigReq": { "description": "RegionInstanceGroupManagers.updatePerInstanceConfigs", "id": "RegionInstanceGroupManagerUpdateInstanceConfigReq", @@ -84213,6 +85230,17 @@ false "readOnly": true, "type": "string" }, +"confidentialComputeType": { +"enum": [ +"CONFIDENTIAL_COMPUTE_TYPE_TDX", +"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED" +], +"enumDescriptions": [ +"Intel Trust Domain Extensions.", +"" +], +"type": "string" +}, "creationTimestamp": { "description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", "readOnly": true, @@ -95870,6 +96898,20 @@ false }, "type": "object" }, +"StructuredEntries": { +"id": "StructuredEntries", +"properties": { +"entries": { +"additionalProperties": { +"format": "google.protobuf.Value", +"type": "any" +}, +"description": "Map of a partner metadata that belong to the same subdomain.\nIt accepts any value including google.protobuf.Struct.", +"type": "object" +} +}, +"type": "object" +}, "Subnetwork": { "description": "Represents a Subnetwork resource.\n\nA subnetwork (also known as a subnet) is a logical partition of a Virtual\nPrivate Cloud network with one primary IP range and zero or more secondary\nIP ranges. For more information, read\nVirtual Private Cloud (VPC) Network.", "id": "Subnetwork", @@ -102183,6 +103225,316 @@ false }, "type": "object" }, +"VmExtensionPolicy": { +"description": "Represents a VM extension policy.", +"id": "VmExtensionPolicy", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional description of this resource.", +"type": "string" +}, +"extensionPolicies": { +"additionalProperties": { +"$ref": "VmExtensionPolicyExtensionPolicy" +}, +"description": "Required. A map of extension names (for example, \"ops-agent\") to their corresponding\npolicy configurations.", +"type": "object" +}, +"globalResourceLink": { +"description": "Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if\napplicable.", +"readOnly": true, +"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" +}, +"instanceSelectors": { +"description": "Optional. Selectors to target VMs for this policy. VMs are selected if they match\n*any* of the provided selectors (logical OR). If this list is empty, the\npolicy applies to all VMs.", +"items": { +"$ref": "VmExtensionPolicyInstanceSelector" +}, +"type": "array" +}, +"kind": { +"default": "compute#vmExtensionPolicy", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.", +"readOnly": true, +"type": "string" +}, +"managedByGlobal": { +"description": "Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.", +"readOnly": true, +"type": "boolean" +}, +"name": { +"annotations": { +"required": [ +"compute.zoneVmExtensionPolicies.insert" +] +}, +"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])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"priority": { +"description": "Optional. Priority of this policy. Used to resolve conflicts when multiple policies\napply to the same extension.\nThe policy priority is an integer from 0 to 65535, inclusive. Lower\nintegers indicate higher priorities. If you do not specify a priority when\ncreating a rule, it is assigned a priority of 1000. If priorities are\nequal, the policy with the most recent creation timestamp takes precedence.", +"format": "int32", +"type": "integer" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.", +"enum": [ +"ACTIVE", +"DELETING", +"STATE_UNSPECIFIED" +], +"enumDescriptions": [ +"The policy is active and applied to matching VMs.\nNewly created VMs that match the policy will also receive the\nextension policy.", +"The policy is in the process of being deleted. After the extension is\nremoved from all matching VMs, the policy will be deleted.", +"Default value. Do not use." +], +"readOnly": true, +"type": "string" +}, +"updateTimestamp": { +"description": "Output only. [Output Only] Update timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"VmExtensionPolicyExtensionPolicy": { +"description": "Configuration for a specific VM extension.", +"id": "VmExtensionPolicyExtensionPolicy", +"properties": { +"pinnedVersion": { +"description": "Optional. The specific version of the extension to install. If not set, the latest\nversion is used.", +"type": "string" +}, +"stringConfig": { +"description": "Optional. String-based configuration data for the extension.", +"type": "string" +} +}, +"type": "object" +}, +"VmExtensionPolicyInstanceSelector": { +"description": "Defines how to select VMs to apply a zone VM extension policy.", +"id": "VmExtensionPolicyInstanceSelector", +"properties": { +"labelSelector": { +"$ref": "VmExtensionPolicyLabelSelector", +"description": "Optional. LabelSelector selects VMs based on their labels." +} +}, +"type": "object" +}, +"VmExtensionPolicyLabelSelector": { +"description": "A LabelSelector is applied to a VM only if it matches all the specified\nlabels.", +"id": "VmExtensionPolicyLabelSelector", +"properties": { +"inclusionLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. A map of key-value pairs representing VM labels.\nVMs must have all of the labels specified in this map to be selected\n(logical AND).\n\ne.g. If the `inclusion_labels` are {(\"key1\", \"value1\"), (\"key2\",\n\"value2\")}, the VM labels must contain both (\"key1\", \"value1\") and\n(\"key2\", \"value2\") to be selected. If the VM labels are (\"key1\",\n\"value1\") and (\"something\", \"else\"), it will not be selected.\n\nIf the map is empty, it's considered a match.", +"type": "object" +} +}, +"type": "object" +}, +"VmExtensionPolicyList": { +"id": "VmExtensionPolicyList", +"properties": { +"etag": { +"description": "Output only. [Output Only] Fingerprint of this resource. A hash of the contents stored\nin this object. This field is used in optimistic locking. This field will\nbe ignored when inserting a VmExtensionPolicy. An up-to-date\nfingerprint must be provided in order to update the VmExtensionPolicy.\n\nTo see the latest value of the fingerprint, make a get() request to\nretrieve a VmExtensionPolicy.", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.", +"readOnly": true, +"type": "string" +}, +"items": { +"description": "Output only. [Output Only] A list of VM extension policy resources.", +"items": { +"$ref": "VmExtensionPolicy" +}, +"readOnly": true, +"type": "array" +}, +"kind": { +"default": "compute#vmExtensionPolicyList", +"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, +"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. [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" +} +}, +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "VpnGateway": { "description": "Represents a HA VPN gateway.\n\nHA VPN is a high-availability (HA) Cloud VPN solution that lets you securely\nconnect your on-premises network to your Google Cloud Virtual Private Cloud\nnetwork through an IPsec VPN connection in a single region.\nFor more information about Cloud HA VPN solutions, see\nCloud VPN topologies .", "id": "VpnGateway", From ee644fcb3f92cb82a843ae5d3e9a5949dbeece16 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:45 +0000 Subject: [PATCH 15/31] feat(contactcenterinsights): update the api #### contactcenterinsights:v1 The following keys were added: - schemas.GoogleCloudContactcenterinsightsV1AnnotatorSelector.properties.runAutoLabelingAnnotator.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata.properties.relabel (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest.properties.relabel.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1ConversationDataSource.properties.turnLevelAudios (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment.properties.turnLevelAudio.$ref (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1Settings.properties.timeZone.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector.properties.runAutoLabelingAnnotator.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata.properties.relabel (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest.properties.relabel.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource.properties.turnLevelAudios (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio (Total Keys: 5) - schemas.GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment.properties.turnLevelAudio.$ref (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1mainAnnotatorSelector.properties.runAutoLabelingAnnotator.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata.properties.relabel (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest.properties.relabel.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1mainConversationDataSource.properties.turnLevelAudios (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio (Total Keys: 5) - schemas.GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment.properties.turnLevelAudio.$ref (Total Keys: 1) --- ...s_v1.projects.locations.analysisRules.html | 6 + ...iewSets.authorizedViews.conversations.html | 22 ++++ ....projects.locations.autoLabelingRules.html | 11 ++ ...ects.locations.conversations.analyses.html | 3 + ...s_v1.projects.locations.conversations.html | 79 +++++++++++++ ...ects.locations.conversations.segments.html | 2 + ...ects.locations.datasets.conversations.html | 22 ++++ ...tcenterinsights_v1.projects.locations.html | 17 +++ .../documents/contactcenterinsights.v1.json | 110 +++++++++++++++++- 9 files changed, 271 insertions(+), 1 deletion(-) diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html index 657993b8d4..30641978ca 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html @@ -127,6 +127,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -174,6 +175,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -246,6 +248,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -304,6 +307,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -370,6 +374,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -418,6 +423,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html index 298b2f44a9..b94c4fcc37 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html @@ -248,6 +248,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -447,6 +453,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -625,6 +632,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. @@ -691,6 +702,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -890,6 +907,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -1068,6 +1086,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html index 07351dfc76..6e3b5adeb1 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html @@ -363,6 +363,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -562,6 +568,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -740,6 +747,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html index 7edc4ec045..99ea348e4b 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html @@ -294,6 +294,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -562,6 +563,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -789,6 +791,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index 013ea64ff2..4119760abb 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -162,6 +162,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -179,6 +180,7 @@

Method Details

}, "filter": "A String", # Required. Filter used to select the subset of conversations to analyze. "parent": "A String", # Required. The parent resource to create analyses in. + "relabel": True or False, # Optional. If true, the labeling rules will be re-evaluated for the conversations. } x__xgafv: string, V1 error format. @@ -340,6 +342,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -539,6 +547,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -717,6 +726,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. @@ -766,6 +779,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -965,6 +984,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -1143,6 +1163,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. @@ -1250,6 +1274,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -1449,6 +1479,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -1627,6 +1658,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. @@ -1762,6 +1797,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -1961,6 +2002,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -2139,6 +2181,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. @@ -2206,6 +2252,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -2405,6 +2457,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -2583,6 +2636,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. @@ -2634,6 +2691,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -2833,6 +2896,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -3011,6 +3075,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. @@ -3119,6 +3187,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -3318,6 +3392,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -3496,6 +3571,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html index 308ea976f0..2623ae6aed 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html @@ -106,6 +106,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -123,6 +124,7 @@

Method Details

}, "filter": "A String", # Required. Filter used to select the subset of conversations to analyze. "parent": "A String", # Required. The parent resource to create analyses in. + "relabel": True or False, # Optional. If true, the labeling rules will be re-evaluated for the conversations. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html index be0fa9cd8f..547fa34a98 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html @@ -303,6 +303,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -502,6 +508,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -680,6 +687,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. @@ -815,6 +826,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -1014,6 +1031,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -1192,6 +1210,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index ed847fc4c5..3ea1c1b452 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -485,6 +485,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -519,6 +520,7 @@

Method Details

"disableWordTimeOffsets": True or False, # Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false. "speechRecognizer": "A String", # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}` }, + "timeZone": "A String", # Optional. The time zone applied to the project. This is a string representation of the time zone, for example, "America/New_York". This field follows the IANA TZ database format. See https://www.iana.org/time-zones for a list of valid values. If no value is set the user time zone will be used. "updateTime": "A String", # Output only. The time at which the settings were last updated. }
@@ -766,6 +768,12 @@

Method Details

"transcriptUri": "A String", # Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. }, "metadataUri": "A String", # Cloud Storage URI that points to a file that contains the conversation metadata. + "turnLevelAudios": [ # Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns. + { # A wrapper for holding the audio for any given turn. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, + ], }, "dialogflowIntents": { # Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} "a_key": { # The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE. @@ -965,6 +973,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -1143,6 +1152,10 @@

Method Details

"score": 3.14, # The sentiment score between -1.0 (negative) and 1.0 (positive). }, "text": "A String", # The text of this segment. + "turnLevelAudio": { # A wrapper for holding the audio for any given turn. # Turn level audio for this transcript segment. + "audioDuration": "A String", # The duration of the audio. + "audioGcsUri": "A String", # The Cloud Storage URI of the audio for any given turn. + }, "words": [ # A list of the word-specific information for each word in the segment. { # Word-level info for words in a transcript. "confidence": 3.14, # A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset. @@ -1284,6 +1297,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -1318,6 +1332,7 @@

Method Details

"disableWordTimeOffsets": True or False, # Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false. "speechRecognizer": "A String", # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}` }, + "timeZone": "A String", # Optional. The time zone applied to the project. This is a string representation of the time zone, for example, "America/New_York". This field follows the IANA TZ database format. See https://www.iana.org/time-zones for a list of valid values. If no value is set the user time zone will be used. "updateTime": "A String", # Output only. The time at which the settings were last updated. } @@ -1346,6 +1361,7 @@

Method Details

], }, }, + "runAutoLabelingAnnotator": True or False, # Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. "runEntityAnnotator": True or False, # Whether to run the entity annotator. "runIntentAnnotator": True or False, # Whether to run the intent annotator. "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator. @@ -1380,6 +1396,7 @@

Method Details

"disableWordTimeOffsets": True or False, # Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false. "speechRecognizer": "A String", # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}` }, + "timeZone": "A String", # Optional. The time zone applied to the project. This is a string representation of the time zone, for example, "America/New_York". This field follows the IANA TZ database format. See https://www.iana.org/time-zones for a list of valid values. If no value is set the user time zone will be used. "updateTime": "A String", # Output only. The time at which the settings were last updated. } diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 6d74d5d1bd..42c52e685f 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -6101,7 +6101,7 @@ } } }, -"revision": "20260219", +"revision": "20260313", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -6292,6 +6292,10 @@ "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig", "description": "Configuration for the QA annotator." }, +"runAutoLabelingAnnotator": { +"description": "Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.", +"type": "boolean" +}, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" @@ -6714,6 +6718,11 @@ true "readOnly": true, "type": "array" }, +"relabel": { +"description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", +"readOnly": true, +"type": "boolean" +}, "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", "description": "The original request for bulk analyze." @@ -6746,6 +6755,10 @@ true "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" +}, +"relabel": { +"description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", +"type": "boolean" } }, "type": "object" @@ -7720,6 +7733,13 @@ true "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" +}, +"turnLevelAudios": { +"description": "Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" +}, +"type": "array" } }, "type": "object" @@ -8014,6 +8034,10 @@ true "description": "The text of this segment.", "type": "string" }, +"turnLevelAudio": { +"$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", +"description": "Turn level audio for this transcript segment." +}, "words": { "description": "A list of the word-specific information for each word in the segment.", "items": { @@ -12400,6 +12424,10 @@ true "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig", "description": "Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform." }, +"timeZone": { +"description": "Optional. The time zone applied to the project. This is a string representation of the time zone, for example, \"America/New_York\". This field follows the IANA TZ database format. See https://www.iana.org/time-zones for a list of valid values. If no value is set the user time zone will be used.", +"type": "string" +}, "updateTime": { "description": "Output only. The time at which the settings were last updated.", "format": "google-datetime", @@ -13073,6 +13101,10 @@ true "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", "description": "Configuration for the QA annotator." }, +"runAutoLabelingAnnotator": { +"description": "Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.", +"type": "boolean" +}, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" @@ -13273,6 +13305,11 @@ true "readOnly": true, "type": "array" }, +"relabel": { +"description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", +"readOnly": true, +"type": "boolean" +}, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest", "description": "The original request for bulk analyze." @@ -13305,6 +13342,10 @@ true "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" +}, +"relabel": { +"description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", +"type": "boolean" } }, "type": "object" @@ -13760,6 +13801,29 @@ true "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" +}, +"turnLevelAudios": { +"description": "Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio": { +"description": "A wrapper for holding the audio for any given turn.", +"id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", +"properties": { +"audioDuration": { +"description": "The duration of the audio.", +"format": "google-duration", +"type": "string" +}, +"audioGcsUri": { +"description": "The Cloud Storage URI of the audio for any given turn.", +"type": "string" } }, "type": "object" @@ -14038,6 +14102,10 @@ true "description": "The text of this segment.", "type": "string" }, +"turnLevelAudio": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", +"description": "Turn level audio for this transcript segment." +}, "words": { "description": "A list of the word-specific information for each word in the segment.", "items": { @@ -17397,6 +17465,10 @@ true "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig", "description": "Configuration for the QA annotator." }, +"runAutoLabelingAnnotator": { +"description": "Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.", +"type": "boolean" +}, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" @@ -17597,6 +17669,11 @@ true "readOnly": true, "type": "array" }, +"relabel": { +"description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", +"readOnly": true, +"type": "boolean" +}, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest", "description": "The original request for bulk analyze." @@ -17629,6 +17706,10 @@ true "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" +}, +"relabel": { +"description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", +"type": "boolean" } }, "type": "object" @@ -18264,6 +18345,29 @@ true "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" +}, +"turnLevelAudios": { +"description": "Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns.", +"items": { +"$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio": { +"description": "A wrapper for holding the audio for any given turn.", +"id": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio", +"properties": { +"audioDuration": { +"description": "The duration of the audio.", +"format": "google-duration", +"type": "string" +}, +"audioGcsUri": { +"description": "The Cloud Storage URI of the audio for any given turn.", +"type": "string" } }, "type": "object" @@ -18542,6 +18646,10 @@ true "description": "The text of this segment.", "type": "string" }, +"turnLevelAudio": { +"$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio", +"description": "Turn level audio for this transcript segment." +}, "words": { "description": "A list of the word-specific information for each word in the segment.", "items": { From e7ad7419e23ac8bee818329be25ad8e0cef4e387 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:45 +0000 Subject: [PATCH 16/31] feat(css): update the api #### css:v1 The following keys were added: - schemas.Attributes.properties.maxRating (Total Keys: 2) - schemas.Attributes.properties.minRating (Total Keys: 2) - schemas.Attributes.properties.rating (Total Keys: 2) - schemas.Attributes.properties.reviewCount (Total Keys: 2) --- .../dyn/css_v1.accounts.cssProductInputs.html | 16 ++++++++++++++ docs/dyn/css_v1.accounts.cssProducts.html | 8 +++++++ .../discovery_cache/documents/css.v1.json | 22 ++++++++++++++++++- 3 files changed, 45 insertions(+), 1 deletion(-) diff --git a/docs/dyn/css_v1.accounts.cssProductInputs.html b/docs/dyn/css_v1.accounts.cssProductInputs.html index fe27498767..af888fb167 100644 --- a/docs/dyn/css_v1.accounts.cssProductInputs.html +++ b/docs/dyn/css_v1.accounts.cssProductInputs.html @@ -197,6 +197,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -231,6 +233,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "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 [size type](https://support.google.com/merchants/answer/6324497). @@ -341,6 +345,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -375,6 +381,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "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 [size type](https://support.google.com/merchants/answer/6324497). @@ -486,6 +494,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -520,6 +530,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "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 [size type](https://support.google.com/merchants/answer/6324497). @@ -630,6 +642,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -664,6 +678,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "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 [size type](https://support.google.com/merchants/answer/6324497). diff --git a/docs/dyn/css_v1.accounts.cssProducts.html b/docs/dyn/css_v1.accounts.cssProducts.html index d6790d4587..fdaa2cd6b4 100644 --- a/docs/dyn/css_v1.accounts.cssProducts.html +++ b/docs/dyn/css_v1.accounts.cssProducts.html @@ -183,6 +183,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -217,6 +219,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "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 [size type](https://support.google.com/merchants/answer/6324497). @@ -369,6 +373,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -403,6 +409,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. "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 [size type](https://support.google.com/merchants/answer/6324497). diff --git a/googleapiclient/discovery_cache/documents/css.v1.json b/googleapiclient/discovery_cache/documents/css.v1.json index 2f2bef946f..a64519505a 100644 --- a/googleapiclient/discovery_cache/documents/css.v1.json +++ b/googleapiclient/discovery_cache/documents/css.v1.json @@ -547,7 +547,7 @@ } } }, -"revision": "20260303", +"revision": "20260310", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -821,6 +821,16 @@ "description": "The material of which the item is made.", "type": "string" }, +"maxRating": { +"description": "Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used.", +"format": "int64", +"type": "string" +}, +"minRating": { +"description": "Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used.", +"format": "int64", +"type": "string" +}, "mpn": { "description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.", "type": "string" @@ -880,6 +890,16 @@ "$ref": "ProductDimension", "description": "The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." }, +"rating": { +"description": "Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used.", +"format": "double", +"type": "number" +}, +"reviewCount": { +"description": "Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used.", +"format": "int64", +"type": "string" +}, "size": { "description": "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)).", "type": "string" From 8abec73202e20ecc92dc34be35d0ee60d0a4592a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:45 +0000 Subject: [PATCH 17/31] feat(datalineage): update the api #### datalineage:v1 The following keys were deleted: - schemas.ApiservingMcpMcpToolDataHandlingProfile (Total Keys: 4) - schemas.ApiservingMcpMcpToolLifecycleProfile (Total Keys: 4) --- .../documents/datalineage.v1.json | 77 +------------------ 1 file changed, 1 insertion(+), 76 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index b9956bf005..bf60acb69e 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -1247,84 +1247,9 @@ } } }, -"revision": "20260130", +"revision": "20260309", "rootUrl": "https://datalineage.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" -}, -"ApiservingMcpMcpToolLifecycleProfile": { -"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": "ApiservingMcpMcpToolLifecycleProfile", -"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" -}, "GoogleCloudDatacatalogLineageConfigmanagementV1Config": { "description": "Configuration for Data Lineage. Defines different configuration options for Lineage customers to control behaviour of lineage systems.", "id": "GoogleCloudDatacatalogLineageConfigmanagementV1Config", From 3834f263bb60bccd631e98b4faeac6ab1e61e762 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:45 +0000 Subject: [PATCH 18/31] feat(dataplex): update the api #### dataplex:v1 The following keys were deleted: - resources.projects.resources.locations.resources.lakes.resources.content.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.lakes.resources.content.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.lakes.resources.content.methods.get (Total Keys: 27) - resources.projects.resources.locations.resources.lakes.resources.content.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.lakes.resources.content.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.lakes.resources.content.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.lakes.resources.content.methods.testIamPermissions (Total Keys: 12) - resources.projects.resources.locations.resources.lakes.resources.contentitems.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.lakes.resources.contentitems.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.lakes.resources.contentitems.methods.get (Total Keys: 27) - resources.projects.resources.locations.resources.lakes.resources.contentitems.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.lakes.resources.contentitems.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.lakes.resources.contentitems.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.lakes.resources.contentitems.methods.testIamPermissions (Total Keys: 12) - resources.projects.resources.locations.resources.lakes.resources.environments.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.lakes.resources.environments.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.lakes.resources.environments.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.lakes.resources.environments.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.lakes.resources.environments.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.lakes.resources.environments.resources.sessions.methods.list (Total Keys: 18) - schemas.GoogleCloudDataplexV1Content (Total Keys: 24) - schemas.GoogleCloudDataplexV1Environment (Total Keys: 59) - schemas.GoogleCloudDataplexV1ListContentResponse (Total Keys: 5) - schemas.GoogleCloudDataplexV1ListEnvironmentsResponse (Total Keys: 5) - schemas.GoogleCloudDataplexV1ListSessionsResponse (Total Keys: 5) - schemas.GoogleCloudDataplexV1Session (Total Keys: 11) The following keys were added: - resources.projects.resources.locations.methods.lookupContext (Total Keys: 12) - schemas.GoogleCloudDataplexV1LookupContextRequest (Total Keys: 6) - schemas.GoogleCloudDataplexV1LookupContextResponse (Total Keys: 3) The following keys were changed: - resources.projects.resources.locations.methods.lookupEntry.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.searchEntries.scopes (Total Keys: 1) --- docs/dyn/dataplex_v1.projects.locations.html | 34 + ...projects.locations.lakes.environments.html | 363 ----- .../dataplex_v1.projects.locations.lakes.html | 10 - .../documents/dataplex.v1.json | 1399 ++--------------- 4 files changed, 200 insertions(+), 1606 deletions(-) diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index 68f7dc300c..455d58479b 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -166,6 +166,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ lookupContext(name, body=None, x__xgafv=None)

+

Looks up LLM Context for the specified resources.

lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)

Looks up an entry by name using the permission on the source system.

@@ -264,6 +267,37 @@

Method Details

+
+ lookupContext(name, body=None, x__xgafv=None) +
Looks up LLM Context for the specified resources.
+
+Args:
+  name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Lookup Context using permissions in the source system.
+  "options": { # Optional. Allows to configure the context.
+    "a_key": "A String",
+  },
+  "resources": [ # Required. The entry names to lookup context for. The request should have max 10 of those.Examples:projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Lookup Context response.
+  "context": "A String", # LLM generated context for the resources.
+}
+
+
lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)
Looks up an entry by name using the permission on the source system.
diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html b/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html
index b063a5b6cd..3aba419e11 100644
--- a/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html
+++ b/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html
@@ -74,35 +74,12 @@
 
 

Cloud Dataplex API . projects . locations . lakes . environments

Instance Methods

-

- sessions() -

-

Returns the sessions Resource.

-

close()

Close httplib2 connections.

-

- create(parent, body=None, environmentId=None, validateOnly=None, x__xgafv=None)

-

Create an environment resource.

-

- delete(name, x__xgafv=None)

-

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

-

- get(name, x__xgafv=None)

-

Get environment resource.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

-

- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists environments under the given lake.

-

- list_next()

-

Retrieves the next page of results.

-

- patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)

-

Update the environment resource.

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@@ -115,182 +92,6 @@

Method Details

Close httplib2 connections.
-
- create(parent, body=None, environmentId=None, validateOnly=None, x__xgafv=None) -
Create an environment resource.
-
-Args:
-  parent: string, Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Environment represents a user-visible compute infrastructure for analytics within a lake.
-  "createTime": "A String", # Output only. Environment creation time.
-  "description": "A String", # Optional. Description of the environment.
-  "displayName": "A String", # Optional. User friendly display name.
-  "endpoints": { # URI Endpoints to access sessions associated with the Environment. # Output only. URI Endpoints to access sessions associated with the Environment.
-    "notebooks": "A String", # Output only. URI to serve notebook APIs
-    "sql": "A String", # Output only. URI to serve SQL APIs
-  },
-  "infrastructureSpec": { # Configuration for the underlying infrastructure used to run workloads. # Required. Infrastructure specification for the Environment.
-    "compute": { # Compute resources associated with the analyze interactive workloads. # Optional. Compute resources needed for analyze interactive workloads.
-      "diskSizeGb": 42, # Optional. Size in GB of the disk. Default is 100 GB.
-      "maxNodeCount": 42, # Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
-      "nodeCount": 42, # Optional. Total number of nodes in the sessions created for this environment.
-    },
-    "osImage": { # Software Runtime Configuration to run Analyze. # Required. Software Runtime Configuration for analyze interactive workloads.
-      "imageVersion": "A String", # Required. Dataplex Universal Catalog Image version.
-      "javaLibraries": [ # Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
-        "A String",
-      ],
-      "properties": { # Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
-        "a_key": "A String",
-      },
-      "pythonPackages": [ # Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
-        "A String",
-      ],
-    },
-  },
-  "labels": { # Optional. User defined labels for the environment.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
-  "sessionSpec": { # Configuration for sessions created for this environment. # Optional. Configuration for sessions created for this environment.
-    "enableFastStartup": True or False, # Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
-    "maxIdleDuration": "A String", # Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
-  },
-  "sessionStatus": { # Status of sessions created for this environment. # Output only. Status of sessions created for this environment.
-    "active": True or False, # Output only. Queries over sessions to mark whether the environment is currently active or not
-  },
-  "state": "A String", # Output only. Current state of the environment.
-  "uid": "A String", # Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the environment was last updated.
-}
-
-  environmentId: string, Required. Environment identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the lake.
-  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- delete(name, x__xgafv=None) -
Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
-
-Args:
-  name: string, Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- get(name, x__xgafv=None) -
Get environment resource.
-
-Args:
-  name: string, Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Environment represents a user-visible compute infrastructure for analytics within a lake.
-  "createTime": "A String", # Output only. Environment creation time.
-  "description": "A String", # Optional. Description of the environment.
-  "displayName": "A String", # Optional. User friendly display name.
-  "endpoints": { # URI Endpoints to access sessions associated with the Environment. # Output only. URI Endpoints to access sessions associated with the Environment.
-    "notebooks": "A String", # Output only. URI to serve notebook APIs
-    "sql": "A String", # Output only. URI to serve SQL APIs
-  },
-  "infrastructureSpec": { # Configuration for the underlying infrastructure used to run workloads. # Required. Infrastructure specification for the Environment.
-    "compute": { # Compute resources associated with the analyze interactive workloads. # Optional. Compute resources needed for analyze interactive workloads.
-      "diskSizeGb": 42, # Optional. Size in GB of the disk. Default is 100 GB.
-      "maxNodeCount": 42, # Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
-      "nodeCount": 42, # Optional. Total number of nodes in the sessions created for this environment.
-    },
-    "osImage": { # Software Runtime Configuration to run Analyze. # Required. Software Runtime Configuration for analyze interactive workloads.
-      "imageVersion": "A String", # Required. Dataplex Universal Catalog Image version.
-      "javaLibraries": [ # Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
-        "A String",
-      ],
-      "properties": { # Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
-        "a_key": "A String",
-      },
-      "pythonPackages": [ # Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
-        "A String",
-      ],
-    },
-  },
-  "labels": { # Optional. User defined labels for the environment.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
-  "sessionSpec": { # Configuration for sessions created for this environment. # Optional. Configuration for sessions created for this environment.
-    "enableFastStartup": True or False, # Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
-    "maxIdleDuration": "A String", # Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
-  },
-  "sessionStatus": { # Status of sessions created for this environment. # Output only. Status of sessions created for this environment.
-    "active": True or False, # Output only. Queries over sessions to mark whether the environment is currently active or not
-  },
-  "state": "A String", # Output only. Current state of the environment.
-  "uid": "A String", # Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the environment was last updated.
-}
-
-
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
@@ -339,170 +140,6 @@ 

Method Details

}
-
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists environments under the given lake.
-
-Args:
-  parent: string, Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}. (required)
-  filter: string, Optional. Filter request.
-  orderBy: string, Optional. Order by fields for the result.
-  pageSize: integer, Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # List environments response.
-  "environments": [ # Environments under the given parent lake.
-    { # Environment represents a user-visible compute infrastructure for analytics within a lake.
-      "createTime": "A String", # Output only. Environment creation time.
-      "description": "A String", # Optional. Description of the environment.
-      "displayName": "A String", # Optional. User friendly display name.
-      "endpoints": { # URI Endpoints to access sessions associated with the Environment. # Output only. URI Endpoints to access sessions associated with the Environment.
-        "notebooks": "A String", # Output only. URI to serve notebook APIs
-        "sql": "A String", # Output only. URI to serve SQL APIs
-      },
-      "infrastructureSpec": { # Configuration for the underlying infrastructure used to run workloads. # Required. Infrastructure specification for the Environment.
-        "compute": { # Compute resources associated with the analyze interactive workloads. # Optional. Compute resources needed for analyze interactive workloads.
-          "diskSizeGb": 42, # Optional. Size in GB of the disk. Default is 100 GB.
-          "maxNodeCount": 42, # Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
-          "nodeCount": 42, # Optional. Total number of nodes in the sessions created for this environment.
-        },
-        "osImage": { # Software Runtime Configuration to run Analyze. # Required. Software Runtime Configuration for analyze interactive workloads.
-          "imageVersion": "A String", # Required. Dataplex Universal Catalog Image version.
-          "javaLibraries": [ # Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
-            "A String",
-          ],
-          "properties": { # Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
-            "a_key": "A String",
-          },
-          "pythonPackages": [ # Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
-            "A String",
-          ],
-        },
-      },
-      "labels": { # Optional. User defined labels for the environment.
-        "a_key": "A String",
-      },
-      "name": "A String", # Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
-      "sessionSpec": { # Configuration for sessions created for this environment. # Optional. Configuration for sessions created for this environment.
-        "enableFastStartup": True or False, # Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
-        "maxIdleDuration": "A String", # Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
-      },
-      "sessionStatus": { # Status of sessions created for this environment. # Output only. Status of sessions created for this environment.
-        "active": True or False, # Output only. Queries over sessions to mark whether the environment is currently active or not
-      },
-      "state": "A String", # Output only. Current state of the environment.
-      "uid": "A String", # Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
-      "updateTime": "A String", # Output only. The time when the environment was last updated.
-    },
-  ],
-  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
-}
-
- -
- list_next() -
Retrieves the next page of results.
-
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
-
-        Returns:
-          A request object that you can call 'execute()' on to request the next
-          page. Returns None if there are no more items in the collection.
-        
-
- -
- patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None) -
Update the environment resource.
-
-Args:
-  name: string, Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Environment represents a user-visible compute infrastructure for analytics within a lake.
-  "createTime": "A String", # Output only. Environment creation time.
-  "description": "A String", # Optional. Description of the environment.
-  "displayName": "A String", # Optional. User friendly display name.
-  "endpoints": { # URI Endpoints to access sessions associated with the Environment. # Output only. URI Endpoints to access sessions associated with the Environment.
-    "notebooks": "A String", # Output only. URI to serve notebook APIs
-    "sql": "A String", # Output only. URI to serve SQL APIs
-  },
-  "infrastructureSpec": { # Configuration for the underlying infrastructure used to run workloads. # Required. Infrastructure specification for the Environment.
-    "compute": { # Compute resources associated with the analyze interactive workloads. # Optional. Compute resources needed for analyze interactive workloads.
-      "diskSizeGb": 42, # Optional. Size in GB of the disk. Default is 100 GB.
-      "maxNodeCount": 42, # Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
-      "nodeCount": 42, # Optional. Total number of nodes in the sessions created for this environment.
-    },
-    "osImage": { # Software Runtime Configuration to run Analyze. # Required. Software Runtime Configuration for analyze interactive workloads.
-      "imageVersion": "A String", # Required. Dataplex Universal Catalog Image version.
-      "javaLibraries": [ # Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
-        "A String",
-      ],
-      "properties": { # Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
-        "a_key": "A String",
-      },
-      "pythonPackages": [ # Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
-        "A String",
-      ],
-    },
-  },
-  "labels": { # Optional. User defined labels for the environment.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
-  "sessionSpec": { # Configuration for sessions created for this environment. # Optional. Configuration for sessions created for this environment.
-    "enableFastStartup": True or False, # Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
-    "maxIdleDuration": "A String", # Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
-  },
-  "sessionStatus": { # Status of sessions created for this environment. # Output only. Status of sessions created for this environment.
-    "active": True or False, # Output only. Queries over sessions to mark whether the environment is currently active or not
-  },
-  "state": "A String", # Output only. Current state of the environment.
-  "uid": "A String", # Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the environment was last updated.
-}
-
-  updateMask: string, Required. Mask of fields to update.
-  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
-  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.
-  },
-}
-
-
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.html b/docs/dyn/dataplex_v1.projects.locations.lakes.html
index 476b82da81..b486d0e58e 100644
--- a/docs/dyn/dataplex_v1.projects.locations.lakes.html
+++ b/docs/dyn/dataplex_v1.projects.locations.lakes.html
@@ -79,16 +79,6 @@ 

Instance Methods

Returns the actions Resource.

-

- content() -

-

Returns the content Resource.

- -

- contentitems() -

-

Returns the contentitems Resource.

-

environments()

diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 980e3cc13b..1741923c75 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -4,6 +4,15 @@ "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." +}, +"https://www.googleapis.com/auth/cloud-platform.read-only": { +"description": "View your data across Google Cloud services and see the email address of your Google Account" +}, +"https://www.googleapis.com/auth/dataplex.read-write": { +"description": "See, edit, configure, and delete your Google Cloud Dataplex data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/dataplex.readonly": { +"description": "See your Google Cloud Dataplex data and the email address of your Google Account" } } } @@ -823,6 +832,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"lookupContext": { +"description": "Looks up LLM Context for the specified resources.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupContext", +"httpMethod": "POST", +"id": "dataplex.projects.locations.lookupContext", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:lookupContext", +"request": { +"$ref": "GoogleCloudDataplexV1LookupContextRequest" +}, +"response": { +"$ref": "GoogleCloudDataplexV1LookupContextResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" +] +}, "lookupEntry": { "description": "Looks up an entry by name using the permission on the source system.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry", @@ -881,7 +920,10 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] }, "lookupEntryLinks": { @@ -999,7 +1041,9 @@ "$ref": "GoogleCloudDataplexV1SearchEntriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] } }, @@ -5244,111 +5288,13 @@ } } }, -"content": { +"environments": { "methods": { -"create": { -"description": "Create a content.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content", -"httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.content.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", -"required": true, -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+parent}/content", -"request": { -"$ref": "GoogleCloudDataplexV1Content" -}, -"response": { -"$ref": "GoogleCloudDataplexV1Content" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Delete a content.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}", -"httpMethod": "DELETE", -"id": "dataplex.projects.locations.lakes.content.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "Empty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Get a content resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.content.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", -"required": true, -"type": "string" -}, -"view": { -"description": "Optional. Specify content view to make a partial request.", -"enum": [ -"CONTENT_VIEW_UNSPECIFIED", -"BASIC", -"FULL" -], -"enumDescriptions": [ -"Content view not specified. Defaults to BASIC. The API will default to the BASIC view.", -"Will not return the data_text field.", -"Returns the complete proto." -], -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudDataplexV1Content" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "getIamPolicy": { -"description": "Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:getIamPolicy", +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:getIamPolicy", "httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.content.getIamPolicy", +"id": "dataplex.projects.locations.lakes.environments.getIamPolicy", "parameterOrder": [ "resource" ], @@ -5362,7 +5308,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", +"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", "required": true, "type": "string" } @@ -5375,91 +5321,11 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "List content.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.content.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 type = \"NOTEBOOK\" type = \"SQL_SCRIPT\"These restrictions can be coinjoined with AND, OR and NOT conjunctions.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. Page token received from a previous ListContent call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContent must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/content", -"response": { -"$ref": "GoogleCloudDataplexV1ListContentResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Update a content. Only supports full resource update.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}", -"httpMethod": "PATCH", -"id": "dataplex.projects.locations.lakes.content.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. Mask of fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudDataplexV1Content" -}, -"response": { -"$ref": "GoogleCloudDataplexV1Content" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "setIamPolicy": { -"description": "Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:setIamPolicy", +"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:setIamPolicy", "httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.content.setIamPolicy", +"id": "dataplex.projects.locations.lakes.environments.setIamPolicy", "parameterOrder": [ "resource" ], @@ -5467,7 +5333,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", +"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", "required": true, "type": "string" } @@ -5484,10 +5350,10 @@ ] }, "testIamPermissions": { -"description": "Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:testIamPermissions", +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:testIamPermissions", "httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.content.testIamPermissions", +"id": "dataplex.projects.locations.lakes.environments.testIamPermissions", "parameterOrder": [ "resource" ], @@ -5495,7 +5361,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/content/.*$", +"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", "required": true, "type": "string" } @@ -5513,111 +5379,101 @@ } } }, -"contentitems": { +"tasks": { "methods": { "create": { -"description": "Create a content.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems", +"description": "Creates a task resource within a lake.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks", "httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.contentitems.create", +"id": "dataplex.projects.locations.lakes.tasks.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", +"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", "required": true, "type": "string" }, +"taskId": { +"description": "Required. Task identifier.", +"location": "query", +"type": "string" +}, "validateOnly": { "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", "location": "query", "type": "boolean" } }, -"path": "v1/{+parent}/contentitems", +"path": "v1/{+parent}/tasks", "request": { -"$ref": "GoogleCloudDataplexV1Content" +"$ref": "GoogleCloudDataplexV1Task" }, "response": { -"$ref": "GoogleCloudDataplexV1Content" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Delete a content.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}", +"description": "Delete the task resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}", "httpMethod": "DELETE", -"id": "dataplex.projects.locations.lakes.contentitems.delete", +"id": "dataplex.projects.locations.lakes.tasks.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", +"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$", +"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "Empty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Get a content resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}", +"description": "Get task resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}", "httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.contentitems.get", +"id": "dataplex.projects.locations.lakes.tasks.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", +"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$", +"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", "required": true, "type": "string" -}, -"view": { -"description": "Optional. Specify content view to make a partial request.", -"enum": [ -"CONTENT_VIEW_UNSPECIFIED", -"BASIC", -"FULL" -], -"enumDescriptions": [ -"Content view not specified. Defaults to BASIC. The API will default to the BASIC view.", -"Will not return the data_text field.", -"Returns the complete proto." -], -"location": "query", -"type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudDataplexV1Content" +"$ref": "GoogleCloudDataplexV1Task" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { -"description": "Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:getIamPolicy", +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:getIamPolicy", "httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.contentitems.getIamPolicy", +"id": "dataplex.projects.locations.lakes.tasks.getIamPolicy", "parameterOrder": [ "resource" ], @@ -5631,7 +5487,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$", +"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", "required": true, "type": "string" } @@ -5645,59 +5501,64 @@ ] }, "list": { -"description": "List content.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems", +"description": "Lists tasks under the given lake.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks", "httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.contentitems.list", +"id": "dataplex.projects.locations.lakes.tasks.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 type = \"NOTEBOOK\" type = \"SQL_SCRIPT\"These restrictions can be coinjoined with AND, OR and NOT conjunctions.", +"description": "Optional. Filter request.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Order by fields for the result.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"description": "Optional. Maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. Page token received from a previous ListContent call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContent must match the call that provided the page token.", +"description": "Optional. Page token received from a previous ListZones call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZones must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}", +"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/contentitems", +"path": "v1/{+parent}/tasks", "response": { -"$ref": "GoogleCloudDataplexV1ListContentResponse" +"$ref": "GoogleCloudDataplexV1ListTasksResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Update a content. Only supports full resource update.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}", +"description": "Update the task resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}", "httpMethod": "PATCH", -"id": "dataplex.projects.locations.lakes.contentitems.patch", +"id": "dataplex.projects.locations.lakes.tasks.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", +"description": "Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$", +"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", "required": true, "type": "string" }, @@ -5715,613 +5576,38 @@ }, "path": "v1/{+name}", "request": { -"$ref": "GoogleCloudDataplexV1Content" +"$ref": "GoogleCloudDataplexV1Task" }, "response": { -"$ref": "GoogleCloudDataplexV1Content" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"setIamPolicy": { -"description": "Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:setIamPolicy", +"run": { +"description": "Run an on demand execution of a Task.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:run", "httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.contentitems.setIamPolicy", +"id": "dataplex.projects.locations.lakes.tasks.run", "parameterOrder": [ -"resource" +"name" ], "parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"name": { +"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$", +"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+resource}:setIamPolicy", +"path": "v1/{+name}:run", "request": { -"$ref": "GoogleIamV1SetIamPolicyRequest" +"$ref": "GoogleCloudDataplexV1RunTaskRequest" }, "response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:testIamPermissions", -"httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.contentitems.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/contentitems/.*$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"environments": { -"methods": { -"create": { -"description": "Create an environment resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments", -"httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.environments.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"environmentId": { -"description": "Required. Environment identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the lake.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", -"required": true, -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+parent}/environments", -"request": { -"$ref": "GoogleCloudDataplexV1Environment" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}", -"httpMethod": "DELETE", -"id": "dataplex.projects.locations.lakes.environments.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Get environment resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.environments.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudDataplexV1Environment" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:getIamPolicy", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.environments.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists environments under the given lake.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.environments.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filter request.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Order by fields for the result.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/environments", -"response": { -"$ref": "GoogleCloudDataplexV1ListEnvironmentsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Update the environment resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}", -"httpMethod": "PATCH", -"id": "dataplex.projects.locations.lakes.environments.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. Mask of fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudDataplexV1Environment" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:setIamPolicy", -"httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.environments.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "GoogleIamV1SetIamPolicyRequest" -}, -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:testIamPermissions", -"httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.environments.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"sessions": { -"methods": { -"list": { -"description": "Lists session resources in an environment.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}/sessions", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.environments.sessions.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filter request. The following mode filter is supported to return only the sessions belonging to the requester when the mode is USER and return sessions of all the users when the mode is ADMIN. When no filter is sent default to USER mode. NOTE: When the mode is ADMIN, the requester should have dataplex.environments.listAllSessions permission to list all sessions, in absence of the permission, the request fails.mode = ADMIN | USER", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 10 sessions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. Page token received from a previous ListSessions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSessions must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/sessions", -"response": { -"$ref": "GoogleCloudDataplexV1ListSessionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -}, -"tasks": { -"methods": { -"create": { -"description": "Creates a task resource within a lake.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks", -"httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.tasks.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", -"required": true, -"type": "string" -}, -"taskId": { -"description": "Required. Task identifier.", -"location": "query", -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+parent}/tasks", -"request": { -"$ref": "GoogleCloudDataplexV1Task" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Delete the task resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}", -"httpMethod": "DELETE", -"id": "dataplex.projects.locations.lakes.tasks.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Get task resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.tasks.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudDataplexV1Task" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:getIamPolicy", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.tasks.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists tasks under the given lake.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks", -"httpMethod": "GET", -"id": "dataplex.projects.locations.lakes.tasks.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filter request.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Order by fields for the result.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. Page token received from a previous ListZones call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZones must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/tasks", -"response": { -"$ref": "GoogleCloudDataplexV1ListTasksResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Update the task resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}", -"httpMethod": "PATCH", -"id": "dataplex.projects.locations.lakes.tasks.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. Mask of fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudDataplexV1Task" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"run": { -"description": "Run an on demand execution of a Task.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:run", -"httpMethod": "POST", -"id": "dataplex.projects.locations.lakes.tasks.run", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:run", -"request": { -"$ref": "GoogleCloudDataplexV1RunTaskRequest" -}, -"response": { -"$ref": "GoogleCloudDataplexV1RunTaskResponse" +"$ref": "GoogleCloudDataplexV1RunTaskResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -7970,7 +7256,7 @@ } } }, -"revision": "20260227", +"revision": "20260310", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -8865,121 +8151,27 @@ ], "type": "string" }, -"message": { -"description": "The log message.", -"type": "string" -}, -"resource": { -"description": "Name of the resource.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1CancelJobRequest": { -"description": "Cancel task jobs.", -"id": "GoogleCloudDataplexV1CancelJobRequest", -"properties": {}, -"type": "object" -}, -"GoogleCloudDataplexV1CancelMetadataJobRequest": { -"description": "Cancel metadata job request.", -"id": "GoogleCloudDataplexV1CancelMetadataJobRequest", -"properties": {}, -"type": "object" -}, -"GoogleCloudDataplexV1Content": { -"description": "Content represents a user-visible notebook or a sql script", -"id": "GoogleCloudDataplexV1Content", -"properties": { -"createTime": { -"description": "Output only. Content creation time.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"dataText": { -"description": "Required. Content data in string format.", -"type": "string" -}, -"description": { -"description": "Optional. Description of the content.", -"type": "string" -}, -"labels": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. User defined labels for the content.", -"type": "object" -}, -"name": { -"description": "Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}", -"readOnly": true, -"type": "string" -}, -"notebook": { -"$ref": "GoogleCloudDataplexV1ContentNotebook", -"description": "Notebook related configurations." -}, -"path": { -"description": "Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.", -"type": "string" -}, -"sqlScript": { -"$ref": "GoogleCloudDataplexV1ContentSqlScript", -"description": "Sql Script related configurations." -}, -"uid": { -"description": "Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time when the content was last updated.", -"format": "google-datetime", -"readOnly": true, +"message": { +"description": "The log message.", "type": "string" -} -}, -"type": "object" }, -"GoogleCloudDataplexV1ContentNotebook": { -"description": "Configuration for Notebook content.", -"id": "GoogleCloudDataplexV1ContentNotebook", -"properties": { -"kernelType": { -"description": "Required. Kernel Type of the notebook.", -"enum": [ -"KERNEL_TYPE_UNSPECIFIED", -"PYTHON3" -], -"enumDescriptions": [ -"Kernel Type unspecified.", -"Python 3 Kernel." -], +"resource": { +"description": "Name of the resource.", "type": "string" } }, "type": "object" }, -"GoogleCloudDataplexV1ContentSqlScript": { -"description": "Configuration for the Sql Script content.", -"id": "GoogleCloudDataplexV1ContentSqlScript", -"properties": { -"engine": { -"description": "Required. Query Engine to be used for the Sql Query.", -"enum": [ -"QUERY_ENGINE_UNSPECIFIED", -"SPARK" -], -"enumDescriptions": [ -"Value was unspecified.", -"Spark SQL Query." -], -"type": "string" -} +"GoogleCloudDataplexV1CancelJobRequest": { +"description": "Cancel task jobs.", +"id": "GoogleCloudDataplexV1CancelJobRequest", +"properties": {}, +"type": "object" }, +"GoogleCloudDataplexV1CancelMetadataJobRequest": { +"description": "Cancel metadata job request.", +"id": "GoogleCloudDataplexV1CancelMetadataJobRequest", +"properties": {}, "type": "object" }, "GoogleCloudDataplexV1DataAccessSpec": { @@ -12202,201 +11394,6 @@ }, "type": "object" }, -"GoogleCloudDataplexV1Environment": { -"description": "Environment represents a user-visible compute infrastructure for analytics within a lake.", -"id": "GoogleCloudDataplexV1Environment", -"properties": { -"createTime": { -"description": "Output only. Environment creation time.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "Optional. Description of the environment.", -"type": "string" -}, -"displayName": { -"description": "Optional. User friendly display name.", -"type": "string" -}, -"endpoints": { -"$ref": "GoogleCloudDataplexV1EnvironmentEndpoints", -"description": "Output only. URI Endpoints to access sessions associated with the Environment.", -"readOnly": true -}, -"infrastructureSpec": { -"$ref": "GoogleCloudDataplexV1EnvironmentInfrastructureSpec", -"description": "Required. Infrastructure specification for the Environment." -}, -"labels": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. User defined labels for the environment.", -"type": "object" -}, -"name": { -"description": "Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}", -"readOnly": true, -"type": "string" -}, -"sessionSpec": { -"$ref": "GoogleCloudDataplexV1EnvironmentSessionSpec", -"description": "Optional. Configuration for sessions created for this environment." -}, -"sessionStatus": { -"$ref": "GoogleCloudDataplexV1EnvironmentSessionStatus", -"description": "Output only. Status of sessions created for this environment.", -"readOnly": true -}, -"state": { -"description": "Output only. Current state of the environment.", -"enum": [ -"STATE_UNSPECIFIED", -"ACTIVE", -"CREATING", -"DELETING", -"ACTION_REQUIRED" -], -"enumDescriptions": [ -"State is not specified.", -"Resource is active, i.e., ready to use.", -"Resource is under creation.", -"Resource is under deletion.", -"Resource is active but has unresolved actions." -], -"readOnly": true, -"type": "string" -}, -"uid": { -"description": "Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time when the environment was last updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1EnvironmentEndpoints": { -"description": "URI Endpoints to access sessions associated with the Environment.", -"id": "GoogleCloudDataplexV1EnvironmentEndpoints", -"properties": { -"notebooks": { -"description": "Output only. URI to serve notebook APIs", -"readOnly": true, -"type": "string" -}, -"sql": { -"description": "Output only. URI to serve SQL APIs", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1EnvironmentInfrastructureSpec": { -"description": "Configuration for the underlying infrastructure used to run workloads.", -"id": "GoogleCloudDataplexV1EnvironmentInfrastructureSpec", -"properties": { -"compute": { -"$ref": "GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources", -"description": "Optional. Compute resources needed for analyze interactive workloads." -}, -"osImage": { -"$ref": "GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime", -"description": "Required. Software Runtime Configuration for analyze interactive workloads." -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources": { -"description": "Compute resources associated with the analyze interactive workloads.", -"id": "GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources", -"properties": { -"diskSizeGb": { -"description": "Optional. Size in GB of the disk. Default is 100 GB.", -"format": "int32", -"type": "integer" -}, -"maxNodeCount": { -"description": "Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.", -"format": "int32", -"type": "integer" -}, -"nodeCount": { -"description": "Optional. Total number of nodes in the sessions created for this environment.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime": { -"description": "Software Runtime Configuration to run Analyze.", -"id": "GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime", -"properties": { -"imageVersion": { -"description": "Required. Dataplex Universal Catalog Image version.", -"type": "string" -}, -"javaLibraries": { -"description": "Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar", -"items": { -"type": "string" -}, -"type": "array" -}, -"properties": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be \"spark\".", -"type": "object" -}, -"pythonPackages": { -"description": "Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1EnvironmentSessionSpec": { -"description": "Configuration for sessions created for this environment.", -"id": "GoogleCloudDataplexV1EnvironmentSessionSpec", -"properties": { -"enableFastStartup": { -"description": "Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to \"default\", and with default configuration.", -"type": "boolean" -}, -"maxIdleDuration": { -"description": "Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.", -"format": "google-duration", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1EnvironmentSessionStatus": { -"description": "Status of sessions created for this environment.", -"id": "GoogleCloudDataplexV1EnvironmentSessionStatus", -"properties": { -"active": { -"description": "Output only. Queries over sessions to mark whether the environment is currently active or not", -"readOnly": true, -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudDataplexV1GenerateDataQualityRulesRequest": { "description": "Request details for generating data quality rule recommendations.", "id": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest", @@ -13075,24 +12072,6 @@ }, "type": "object" }, -"GoogleCloudDataplexV1ListContentResponse": { -"description": "List content response.", -"id": "GoogleCloudDataplexV1ListContentResponse", -"properties": { -"content": { -"description": "Content under the given parent lake.", -"items": { -"$ref": "GoogleCloudDataplexV1Content" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDataplexV1ListDataAssetsResponse": { "description": "Response message for listing data assets.", "id": "GoogleCloudDataplexV1ListDataAssetsResponse", @@ -13365,24 +12344,6 @@ }, "type": "object" }, -"GoogleCloudDataplexV1ListEnvironmentsResponse": { -"description": "List environments response.", -"id": "GoogleCloudDataplexV1ListEnvironmentsResponse", -"properties": { -"environments": { -"description": "Environments under the given parent lake.", -"items": { -"$ref": "GoogleCloudDataplexV1Environment" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDataplexV1ListGlossariesResponse": { "description": "List Glossaries Response", "id": "GoogleCloudDataplexV1ListGlossariesResponse", @@ -13569,24 +12530,6 @@ }, "type": "object" }, -"GoogleCloudDataplexV1ListSessionsResponse": { -"description": "List sessions response.", -"id": "GoogleCloudDataplexV1ListSessionsResponse", -"properties": { -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -}, -"sessions": { -"description": "Sessions under a given environment.", -"items": { -"$ref": "GoogleCloudDataplexV1Session" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDataplexV1ListTasksResponse": { "description": "List tasks response.", "id": "GoogleCloudDataplexV1ListTasksResponse", @@ -13630,6 +12573,38 @@ }, "type": "object" }, +"GoogleCloudDataplexV1LookupContextRequest": { +"description": "Lookup Context using permissions in the source system.", +"id": "GoogleCloudDataplexV1LookupContextRequest", +"properties": { +"options": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Allows to configure the context.", +"type": "object" +}, +"resources": { +"description": "Required. The entry names to lookup context for. The request should have max 10 of those.Examples:projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1LookupContextResponse": { +"description": "Lookup Context response.", +"id": "GoogleCloudDataplexV1LookupContextResponse", +"properties": { +"context": { +"description": "LLM generated context for the resources.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1LookupEntryLinksResponse": { "description": "Response message for LookupEntryLinks.", "id": "GoogleCloudDataplexV1LookupEntryLinksResponse", @@ -14538,48 +13513,6 @@ }, "type": "object" }, -"GoogleCloudDataplexV1Session": { -"description": "Represents an active analyze session running for a user.", -"id": "GoogleCloudDataplexV1Session", -"properties": { -"createTime": { -"description": "Output only. Session start time.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id}", -"readOnly": true, -"type": "string" -}, -"state": { -"description": "Output only. State of Session", -"enum": [ -"STATE_UNSPECIFIED", -"ACTIVE", -"CREATING", -"DELETING", -"ACTION_REQUIRED" -], -"enumDescriptions": [ -"State is not specified.", -"Resource is active, i.e., ready to use.", -"Resource is under creation.", -"Resource is under deletion.", -"Resource is active but has unresolved actions." -], -"readOnly": true, -"type": "string" -}, -"userId": { -"description": "Output only. Email of user running the session.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDataplexV1SessionEvent": { "description": "These messages contain information about sessions within an environment. The monitored resource is 'Environment'.", "id": "GoogleCloudDataplexV1SessionEvent", From e51e83aa00e8cae6ad874e422b675fe0ca15c451 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:45 +0000 Subject: [PATCH 19/31] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1Engine.properties.procurementContactEmail.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.procurementContactEmail.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.procurementContactEmail.type (Total Keys: 1) The following keys were added: - schemas.GoogleCloudDiscoveryengineV1AgentGatewaySetting (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.agentGatewaySetting.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.procurementContactEmail (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.agentGatewaySetting.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.procurementContactEmail (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaFieldConfig.properties.searchableFieldImportance.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaAgentGatewaySetting (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.agentGatewaySetting.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.procurementContactEmail (Total Keys: 2) #### discoveryengine:v1alpha The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1Engine.properties.procurementContactEmail.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.procurementContactEmail.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.procurementContactEmail.type (Total Keys: 1) The following keys were added: - schemas.GoogleCloudDiscoveryengineV1AgentGatewaySetting (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.agentGatewaySetting.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.procurementContactEmail (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.agentGatewaySetting.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.procurementContactEmail (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaFieldConfig.properties.searchableFieldImportance.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaAgentGatewaySetting (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.agentGatewaySetting.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.procurementContactEmail (Total Keys: 2) #### discoveryengine:v1beta The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1Engine.properties.procurementContactEmail.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.procurementContactEmail.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.procurementContactEmail.type (Total Keys: 1) The following keys were added: - schemas.GoogleCloudDiscoveryengineV1AgentGatewaySetting (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.agentGatewaySetting.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.procurementContactEmail (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.agentGatewaySetting.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.procurementContactEmail (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaFieldConfig.properties.searchableFieldImportance.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaAgentGatewaySetting (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.agentGatewaySetting.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.procurementContactEmail (Total Keys: 2) --- ...rojects.locations.collections.engines.html | 65 ++++++-- ...cts.locations.userStores.userLicenses.html | 2 +- .../dyn/discoveryengine_v1alpha.projects.html | 16 +- ...ects.locations.collections.dataStores.html | 5 + ...ations.collections.dataStores.schemas.html | 4 + ...rojects.locations.collections.engines.html | 91 ++++++++--- ...1alpha.projects.locations.collections.html | 42 +++--- ...v1alpha.projects.locations.dataStores.html | 5 + ...projects.locations.dataStores.schemas.html | 4 + ...veryengine_v1alpha.projects.locations.html | 14 +- ...cts.locations.userStores.userLicenses.html | 2 +- ...rojects.locations.collections.engines.html | 91 ++++++++--- ...cts.locations.userStores.userLicenses.html | 2 +- .../documents/discoveryengine.v1.json | 141 +++++++++++++++--- .../documents/discoveryengine.v1alpha.json | 141 +++++++++++++++--- .../documents/discoveryengine.v1beta.json | 141 +++++++++++++++--- 16 files changed, 623 insertions(+), 143 deletions(-) diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index c8b1ac5f66..096939ad42 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -157,6 +157,11 @@

Method Details

The object takes the form of: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -241,10 +246,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -336,6 +343,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -420,10 +432,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -491,6 +505,11 @@

Method Details

{ # Response message for EngineService.ListEngines method. "engines": [ # All the customer's Engines. { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -575,10 +594,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -618,6 +639,11 @@

Method Details

The object takes the form of: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -702,10 +728,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -727,6 +755,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -811,10 +844,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.userStores.userLicenses.html b/docs/dyn/discoveryengine_v1.projects.locations.userStores.userLicenses.html index 79fa4cdbc3..a886cb3cb4 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.userStores.userLicenses.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.userStores.userLicenses.html @@ -96,7 +96,7 @@

Method Details

Args: parent: string, Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. (required) orderBy: string, Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order. - pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. + pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 1000. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. pageToken: string, Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/discoveryengine_v1alpha.projects.html b/docs/dyn/discoveryengine_v1alpha.projects.html index b9499f5520..653e163166 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.html @@ -141,8 +141,8 @@

Method Details

"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt. }, "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for NotebookLM. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, "optOutNotebookSharing": True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. }, @@ -192,8 +192,8 @@

Method Details

"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt. }, "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for NotebookLM. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, "optOutNotebookSharing": True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. }, @@ -242,8 +242,8 @@

Method Details

"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt. }, "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for NotebookLM. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, "optOutNotebookSharing": True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. }, @@ -354,8 +354,8 @@

Method Details

"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt. }, "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for NotebookLM. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, "optOutNotebookSharing": True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index f30f81b39f..1f38a6a9ac 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -465,6 +465,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -784,6 +785,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1100,6 +1102,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1321,6 +1324,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1524,6 +1528,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html index f999f2e733..3484fa59ae 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html @@ -133,6 +133,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -240,6 +241,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -288,6 +290,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -342,6 +345,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index 0f467286ff..d30577149e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -174,6 +174,11 @@

Method Details

The object takes the form of: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -258,10 +263,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. "dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. "lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines. @@ -362,6 +369,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -446,10 +458,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. "dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. "lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines. @@ -545,6 +559,11 @@

Method Details

{ # Response message for EngineService.ListEngines method. "engines": [ # All the customer's Engines. { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -629,10 +648,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. "dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. "lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines. @@ -681,6 +702,11 @@

Method Details

The object takes the form of: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -765,10 +791,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. "dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. "lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines. @@ -799,6 +827,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -883,10 +916,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. "dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. "lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines. @@ -929,6 +964,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -1013,10 +1053,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. "dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. "lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines. @@ -1059,6 +1101,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -1143,10 +1190,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. "dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. "lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index d4552b87f3..dc65e02b6f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -223,9 +223,9 @@

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. - "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector. - "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source. - "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, "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` @@ -297,6 +297,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -469,9 +470,9 @@

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. - "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector. - "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source. - "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, "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` @@ -543,6 +544,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -719,9 +721,9 @@

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. - "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector. - "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source. - "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, "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` @@ -793,6 +795,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -979,9 +982,9 @@

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. - "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector. - "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source. - "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, "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` @@ -1053,6 +1056,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1249,9 +1253,9 @@

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. - "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector. - "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source. - "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, "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` @@ -1323,6 +1327,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1486,9 +1491,9 @@

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. - "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector. - "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source. - "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, "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` @@ -1560,6 +1565,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index dc20db29a7..cfdcac5138 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -457,6 +457,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -776,6 +777,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1092,6 +1094,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1313,6 +1316,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1516,6 +1520,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html index 4b29d5eaa4..438c24c273 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html @@ -128,6 +128,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -235,6 +236,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -283,6 +285,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -337,6 +340,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 660b143c41..4061e5bfaf 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -1090,9 +1090,9 @@

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. - "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector. - "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source. - "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, "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` @@ -1164,6 +1164,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1357,9 +1358,9 @@

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. - "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector. - "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source. - "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. }, }, "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` @@ -1431,6 +1432,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html index 5b58d2c2ac..58592cce33 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html @@ -96,7 +96,7 @@

Method Details

Args: parent: string, Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. (required) orderBy: string, Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order. - pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. + pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 1000. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. pageToken: string, Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index a7051e45f2..d69a9f131d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html @@ -161,6 +161,11 @@

Method Details

The object takes the form of: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -245,10 +250,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -340,6 +347,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -424,10 +436,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -495,6 +509,11 @@

Method Details

{ # Response message for EngineService.ListEngines method. "engines": [ # All the customer's Engines. { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -579,10 +598,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -622,6 +643,11 @@

Method Details

The object takes the form of: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -706,10 +732,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -731,6 +759,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -815,10 +848,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -852,6 +887,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -936,10 +976,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. @@ -973,6 +1015,11 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "agentGatewaySetting": { # Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. # Optional. The agent gateway setting for the engine. + "defaultEgressAgentGateway": { # Reference to an Agent Gateway resource. # Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. + "name": "A String", # Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. + }, + }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. @@ -1057,10 +1104,12 @@

Method Details

}, "name": "A String", # Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. "observabilityConfig": { # Observability config for a resource. # Optional. Observability config for the engine. - "observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored. - "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields. + "observabilityEnabled": True or False, # Optional. Enables observability. If `false`, all other flags are ignored. + "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. }, - "procurementContactEmail": "A String", # Optional. The email of the procurement contact. + "procurementContactEmails": [ # Optional. The emails of the procurement contacts. + "A String", + ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. "searchAddOns": [ # The add-on that this search engine enables. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.userLicenses.html b/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.userLicenses.html index a3c41cae3f..1d0de6f77c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.userLicenses.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.userLicenses.html @@ -96,7 +96,7 @@

Method Details

Args: parent: string, Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. (required) orderBy: string, Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order. - pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. + pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 1000. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. pageToken: string, Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index f9172680fc..9787e00ad6 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -9076,7 +9076,7 @@ "type": "string" }, "pageSize": { -"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.", +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 1000. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", "format": "int32", "location": "query", "type": "integer" @@ -9218,7 +9218,7 @@ } } }, -"revision": "20260301", +"revision": "20260310", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "A2aV1APIKeySecurityScheme": { @@ -10981,6 +10981,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AgentGatewaySetting": { +"description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", +"id": "GoogleCloudDiscoveryengineV1AgentGatewaySetting", +"properties": { +"defaultEgressAgentGateway": { +"$ref": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference", +"description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference": { +"description": "Reference to an Agent Gateway resource.", +"id": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference", +"properties": { +"name": { +"description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1AlertPolicyConfig": { "description": "The connector level alert config.", "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig", @@ -15888,6 +15910,10 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1Engine", "properties": { +"agentGatewaySetting": { +"$ref": "GoogleCloudDiscoveryengineV1AgentGatewaySetting", +"description": "Optional. The agent gateway setting for the engine." +}, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enum": [ @@ -16042,10 +16068,13 @@ "$ref": "GoogleCloudDiscoveryengineV1ObservabilityConfig", "description": "Optional. Observability config for the engine." }, -"procurementContactEmail": { -"description": "Optional. The email of the procurement contact.", +"procurementContactEmails": { +"description": "Optional. The emails of the procurement contacts.", +"items": { "type": "string" }, +"type": "array" +}, "searchEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." @@ -17598,11 +17627,11 @@ "id": "GoogleCloudDiscoveryengineV1ObservabilityConfig", "properties": { "observabilityEnabled": { -"description": "Optional. Enables observability. If false, all other flags are ignored.", +"description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { -"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.", +"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, @@ -21947,6 +21976,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting": { +"description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", +"id": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting", +"properties": { +"defaultEgressAgentGateway": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference", +"description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference": { +"description": "Reference to an Agent Gateway resource.", +"id": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference", +"properties": { +"name": { +"description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { "description": "The connector level alert config.", "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", @@ -24478,12 +24529,12 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy": { -"description": "Data protection policy config for a connector.", +"description": "Contains the data protection policy config for a DataStore or a connector.", "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy", "properties": { "sensitiveDataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy", -"description": "Optional. The sensitive data protection policy for the connector source." +"description": "Optional. Specifies the sensitive data protection policy for the connector source." } }, "type": "object" @@ -24493,7 +24544,7 @@ false "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy", "properties": { "policy": { -"description": "Optional. The Sensitive Data Protection content policy resource name.", +"description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", "type": "string" } }, @@ -25295,6 +25346,10 @@ false "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { +"agentGatewaySetting": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting", +"description": "Optional. The agent gateway setting for the engine." +}, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enum": [ @@ -25449,10 +25504,13 @@ false "$ref": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig", "description": "Optional. Observability config for the engine." }, -"procurementContactEmail": { -"description": "Optional. The email of the procurement contact.", +"procurementContactEmails": { +"description": "Optional. The emails of the procurement contacts.", +"items": { "type": "string" }, +"type": "array" +}, "recommendationMetadata": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", @@ -26122,6 +26180,26 @@ false }, "type": "array" }, +"searchableFieldImportance": { +"description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.", +"enum": [ +"SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED", +"VERY_LOW_IMPORTANCE", +"LOW_IMPORTANCE", +"DEFAULT_IMPORTANCE", +"HIGH_IMPORTANCE", +"VERY_HIGH_IMPORTANCE" +], +"enumDescriptions": [ +"Value used when unset. Behaves as `DEFAULT_IMPORTANCE` if the field is searchable.", +"Provides a tiny signal for search.", +"Indicates the field is used for search, but is less important than the default.", +"Default importance. Equivalent to previous behavior.", +"More important than default fields.", +"Most important field for search." +], +"type": "string" +}, "searchableOption": { "description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ @@ -26785,11 +26863,11 @@ false "id": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig", "properties": { "observabilityEnabled": { -"description": "Optional. Enables observability. If false, all other flags are ignored.", +"description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { -"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.", +"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, @@ -29412,6 +29490,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAgentGatewaySetting": { +"description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", +"id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting", +"properties": { +"defaultEgressAgentGateway": { +"$ref": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference", +"description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference": { +"description": "Reference to an Agent Gateway resource.", +"id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference", +"properties": { +"name": { +"description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -30621,6 +30721,10 @@ false "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1betaEngine", "properties": { +"agentGatewaySetting": { +"$ref": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting", +"description": "Optional. The agent gateway setting for the engine." +}, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enum": [ @@ -30775,10 +30879,13 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaObservabilityConfig", "description": "Optional. Observability config for the engine." }, -"procurementContactEmail": { -"description": "Optional. The email of the procurement contact.", +"procurementContactEmails": { +"description": "Optional. The emails of the procurement contacts.", +"items": { "type": "string" }, +"type": "array" +}, "searchEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." @@ -31732,11 +31839,11 @@ false "id": "GoogleCloudDiscoveryengineV1betaObservabilityConfig", "properties": { "observabilityEnabled": { -"description": "Optional. Enables observability. If false, all other flags are ignored.", +"description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { -"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.", +"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 0d635dab92..d0902ffb67 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -12137,7 +12137,7 @@ "type": "string" }, "pageSize": { -"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.", +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 1000. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", "format": "int32", "location": "query", "type": "integer" @@ -12250,7 +12250,7 @@ } } }, -"revision": "20260301", +"revision": "20260310", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -12749,6 +12749,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AgentGatewaySetting": { +"description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", +"id": "GoogleCloudDiscoveryengineV1AgentGatewaySetting", +"properties": { +"defaultEgressAgentGateway": { +"$ref": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference", +"description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference": { +"description": "Reference to an Agent Gateway resource.", +"id": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference", +"properties": { +"name": { +"description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1AlertPolicyConfig": { "description": "The connector level alert config.", "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig", @@ -14845,6 +14867,10 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1Engine", "properties": { +"agentGatewaySetting": { +"$ref": "GoogleCloudDiscoveryengineV1AgentGatewaySetting", +"description": "Optional. The agent gateway setting for the engine." +}, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enum": [ @@ -14999,10 +15025,13 @@ "$ref": "GoogleCloudDiscoveryengineV1ObservabilityConfig", "description": "Optional. Observability config for the engine." }, -"procurementContactEmail": { -"description": "Optional. The email of the procurement contact.", +"procurementContactEmails": { +"description": "Optional. The emails of the procurement contacts.", +"items": { "type": "string" }, +"type": "array" +}, "searchEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." @@ -15779,11 +15808,11 @@ "id": "GoogleCloudDiscoveryengineV1ObservabilityConfig", "properties": { "observabilityEnabled": { -"description": "Optional. Enables observability. If false, all other flags are ignored.", +"description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { -"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.", +"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, @@ -17561,6 +17590,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting": { +"description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", +"id": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting", +"properties": { +"defaultEgressAgentGateway": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference", +"description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference": { +"description": "Reference to an Agent Gateway resource.", +"id": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference", +"properties": { +"name": { +"description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAgentImage": { "description": "Represents an image.", "id": "GoogleCloudDiscoveryengineV1alphaAgentImage", @@ -22530,12 +22581,12 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy": { -"description": "Data protection policy config for a connector.", +"description": "Contains the data protection policy config for a DataStore or a connector.", "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy", "properties": { "sensitiveDataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy", -"description": "Optional. The sensitive data protection policy for the connector source." +"description": "Optional. Specifies the sensitive data protection policy for the connector source." } }, "type": "object" @@ -22545,7 +22596,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy", "properties": { "policy": { -"description": "Optional. The Sensitive Data Protection content policy resource name.", +"description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", "type": "string" } }, @@ -23611,6 +23662,10 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { +"agentGatewaySetting": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting", +"description": "Optional. The agent gateway setting for the engine." +}, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enum": [ @@ -23765,10 +23820,13 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig", "description": "Optional. Observability config for the engine." }, -"procurementContactEmail": { -"description": "Optional. The email of the procurement contact.", +"procurementContactEmails": { +"description": "Optional. The emails of the procurement contacts.", +"items": { "type": "string" }, +"type": "array" +}, "recommendationMetadata": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", @@ -24673,6 +24731,26 @@ }, "type": "array" }, +"searchableFieldImportance": { +"description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.", +"enum": [ +"SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED", +"VERY_LOW_IMPORTANCE", +"LOW_IMPORTANCE", +"DEFAULT_IMPORTANCE", +"HIGH_IMPORTANCE", +"VERY_HIGH_IMPORTANCE" +], +"enumDescriptions": [ +"Value used when unset. Behaves as `DEFAULT_IMPORTANCE` if the field is searchable.", +"Provides a tiny signal for search.", +"Indicates the field is used for search, but is less important than the default.", +"Default importance. Equivalent to previous behavior.", +"More important than default fields.", +"Most important field for search." +], +"type": "string" +}, "searchableOption": { "description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ @@ -26535,11 +26613,11 @@ "id": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig", "properties": { "observabilityEnabled": { -"description": "Optional. Enables observability. If false, all other flags are ignored.", +"description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { -"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.", +"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, @@ -32605,6 +32683,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAgentGatewaySetting": { +"description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", +"id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting", +"properties": { +"defaultEgressAgentGateway": { +"$ref": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference", +"description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference": { +"description": "Reference to an Agent Gateway resource.", +"id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference", +"properties": { +"name": { +"description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -33814,6 +33914,10 @@ false "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1betaEngine", "properties": { +"agentGatewaySetting": { +"$ref": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting", +"description": "Optional. The agent gateway setting for the engine." +}, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enum": [ @@ -33968,10 +34072,13 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaObservabilityConfig", "description": "Optional. Observability config for the engine." }, -"procurementContactEmail": { -"description": "Optional. The email of the procurement contact.", +"procurementContactEmails": { +"description": "Optional. The emails of the procurement contacts.", +"items": { "type": "string" }, +"type": "array" +}, "searchEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." @@ -34925,11 +35032,11 @@ false "id": "GoogleCloudDiscoveryengineV1betaObservabilityConfig", "properties": { "observabilityEnabled": { -"description": "Optional. Enables observability. If false, all other flags are ignored.", +"description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { -"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.", +"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 72300e3de6..057b8c2177 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -9054,7 +9054,7 @@ "type": "string" }, "pageSize": { -"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.", +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 1000. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", "format": "int32", "location": "query", "type": "integer" @@ -9167,7 +9167,7 @@ } } }, -"revision": "20260301", +"revision": "20260310", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -9666,6 +9666,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AgentGatewaySetting": { +"description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", +"id": "GoogleCloudDiscoveryengineV1AgentGatewaySetting", +"properties": { +"defaultEgressAgentGateway": { +"$ref": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference", +"description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference": { +"description": "Reference to an Agent Gateway resource.", +"id": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference", +"properties": { +"name": { +"description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1AlertPolicyConfig": { "description": "The connector level alert config.", "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig", @@ -11762,6 +11784,10 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1Engine", "properties": { +"agentGatewaySetting": { +"$ref": "GoogleCloudDiscoveryengineV1AgentGatewaySetting", +"description": "Optional. The agent gateway setting for the engine." +}, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enum": [ @@ -11916,10 +11942,13 @@ "$ref": "GoogleCloudDiscoveryengineV1ObservabilityConfig", "description": "Optional. Observability config for the engine." }, -"procurementContactEmail": { -"description": "Optional. The email of the procurement contact.", +"procurementContactEmails": { +"description": "Optional. The emails of the procurement contacts.", +"items": { "type": "string" }, +"type": "array" +}, "searchEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." @@ -12696,11 +12725,11 @@ "id": "GoogleCloudDiscoveryengineV1ObservabilityConfig", "properties": { "observabilityEnabled": { -"description": "Optional. Enables observability. If false, all other flags are ignored.", +"description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { -"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.", +"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, @@ -13959,6 +13988,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting": { +"description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", +"id": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting", +"properties": { +"defaultEgressAgentGateway": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference", +"description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference": { +"description": "Reference to an Agent Gateway resource.", +"id": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference", +"properties": { +"name": { +"description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { "description": "The connector level alert config.", "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", @@ -16490,12 +16541,12 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy": { -"description": "Data protection policy config for a connector.", +"description": "Contains the data protection policy config for a DataStore or a connector.", "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy", "properties": { "sensitiveDataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy", -"description": "Optional. The sensitive data protection policy for the connector source." +"description": "Optional. Specifies the sensitive data protection policy for the connector source." } }, "type": "object" @@ -16505,7 +16556,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy", "properties": { "policy": { -"description": "Optional. The Sensitive Data Protection content policy resource name.", +"description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", "type": "string" } }, @@ -17307,6 +17358,10 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { +"agentGatewaySetting": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting", +"description": "Optional. The agent gateway setting for the engine." +}, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enum": [ @@ -17461,10 +17516,13 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig", "description": "Optional. Observability config for the engine." }, -"procurementContactEmail": { -"description": "Optional. The email of the procurement contact.", +"procurementContactEmails": { +"description": "Optional. The emails of the procurement contacts.", +"items": { "type": "string" }, +"type": "array" +}, "recommendationMetadata": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", @@ -18134,6 +18192,26 @@ }, "type": "array" }, +"searchableFieldImportance": { +"description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.", +"enum": [ +"SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED", +"VERY_LOW_IMPORTANCE", +"LOW_IMPORTANCE", +"DEFAULT_IMPORTANCE", +"HIGH_IMPORTANCE", +"VERY_HIGH_IMPORTANCE" +], +"enumDescriptions": [ +"Value used when unset. Behaves as `DEFAULT_IMPORTANCE` if the field is searchable.", +"Provides a tiny signal for search.", +"Indicates the field is used for search, but is less important than the default.", +"Default importance. Equivalent to previous behavior.", +"More important than default fields.", +"Most important field for search." +], +"type": "string" +}, "searchableOption": { "description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ @@ -18797,11 +18875,11 @@ "id": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig", "properties": { "observabilityEnabled": { -"description": "Optional. Enables observability. If false, all other flags are ignored.", +"description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { -"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.", +"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, @@ -21736,6 +21814,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAgentGatewaySetting": { +"description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", +"id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting", +"properties": { +"defaultEgressAgentGateway": { +"$ref": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference", +"description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference": { +"description": "Reference to an Agent Gateway resource.", +"id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference", +"properties": { +"name": { +"description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -26125,6 +26225,10 @@ false "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1betaEngine", "properties": { +"agentGatewaySetting": { +"$ref": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting", +"description": "Optional. The agent gateway setting for the engine." +}, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enum": [ @@ -26279,10 +26383,13 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaObservabilityConfig", "description": "Optional. Observability config for the engine." }, -"procurementContactEmail": { -"description": "Optional. The email of the procurement contact.", +"procurementContactEmails": { +"description": "Optional. The emails of the procurement contacts.", +"items": { "type": "string" }, +"type": "array" +}, "searchEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." @@ -28111,11 +28218,11 @@ false "id": "GoogleCloudDiscoveryengineV1betaObservabilityConfig", "properties": { "observabilityEnabled": { -"description": "Optional. Enables observability. If false, all other flags are ignored.", +"description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { -"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.", +"description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, From 6346814a18e61174f5e72a0619f9ef66cdd5d9d7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:45 +0000 Subject: [PATCH 20/31] feat(displayvideo): update the api #### displayvideo:v2 The following keys were added: - schemas.TargetingExpansionConfig.properties.excludeDemographicExpansion.type (Total Keys: 1) #### displayvideo:v3 The following keys were added: - schemas.TargetingExpansionConfig.properties.excludeDemographicExpansion.type (Total Keys: 1) #### displayvideo:v4 The following keys were added: - schemas.TargetingExpansionConfig.properties.excludeDemographicExpansion.type (Total Keys: 1) --- ...displayvideo_v2.advertisers.lineItems.html | 7 +++++ ...yvideo_v2.advertisers.youtubeAdGroups.html | 2 ++ ...isplayvideo_v3.advertisers.adGroupAds.html | 12 ++++---- .../displayvideo_v3.advertisers.adGroups.html | 30 +++++++++++-------- ...displayvideo_v3.advertisers.lineItems.html | 7 +++++ ...isplayvideo_v4.advertisers.adGroupAds.html | 12 ++++---- .../displayvideo_v4.advertisers.adGroups.html | 30 +++++++++++-------- ...displayvideo_v4.advertisers.lineItems.html | 7 +++++ .../documents/displayvideo.v2.json | 24 ++++++++++----- .../documents/displayvideo.v3.json | 30 ++++++++++++------- .../documents/displayvideo.v4.json | 30 ++++++++++++------- 11 files changed, 128 insertions(+), 63 deletions(-) diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html index e025568a66..307f516c36 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -937,6 +937,7 @@

Method Details

}, "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. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1205,6 +1206,7 @@

Method Details

}, "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. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1433,6 +1435,7 @@

Method Details

}, "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. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1716,6 +1719,7 @@

Method Details

}, "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. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1957,6 +1961,7 @@

Method Details

}, "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. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -2205,6 +2210,7 @@

Method Details

}, "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. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -2434,6 +2440,7 @@

Method Details

}, "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. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html index 67c7fd8a69..cf9540093a 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html @@ -474,6 +474,7 @@

Method Details

"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. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group. This config is only applicable when eligible audience list targeting is assigned to the ad group. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -532,6 +533,7 @@

Method Details

"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. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group. This config is only applicable when eligible audience list targeting is assigned to the ad group. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html index 4da31a20b0..024e7887b6 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html @@ -112,7 +112,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -620,7 +620,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -1155,7 +1155,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -1676,7 +1676,7 @@

Method Details

"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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -2204,7 +2204,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -2713,7 +2713,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index c2664f2cea..810d0c3012 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -883,7 +883,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -928,7 +928,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -947,6 +947,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, } @@ -959,7 +960,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1004,7 +1005,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1023,6 +1024,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, }
@@ -1062,7 +1064,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1107,7 +1109,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1126,6 +1128,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, } @@ -1151,7 +1154,7 @@

Method Details

{ "adGroups": [ # The list of ad groups. This list will be absent if empty. { # A single ad group associated with a line item. - "adGroupFormat": "A String", # Required. The format of the ads in the ad group. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1196,7 +1199,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1215,6 +1218,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, }, ], @@ -1247,7 +1251,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1292,7 +1296,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1311,6 +1315,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, } @@ -1324,7 +1329,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1369,7 +1374,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1388,6 +1393,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, } diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html index 23fb202b42..c20faf6ce8 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html @@ -1032,6 +1032,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1300,6 +1301,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1528,6 +1530,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1811,6 +1814,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2052,6 +2056,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2300,6 +2305,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2529,6 +2535,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html index 221739a601..efd432f271 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -112,7 +112,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -620,7 +620,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -1155,7 +1155,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -1676,7 +1676,7 @@

Method Details

"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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -2204,7 +2204,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. @@ -2713,7 +2713,7 @@

Method Details

{ # 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. + "adGroupId": "A String", # Required. Immutable. 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. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html index b52da0d4c6..e174af0387 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html @@ -888,7 +888,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -933,7 +933,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -952,6 +952,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, } @@ -964,7 +965,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1009,7 +1010,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1028,6 +1029,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, } @@ -1067,7 +1069,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1112,7 +1114,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1131,6 +1133,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, } @@ -1156,7 +1159,7 @@

Method Details

{ "adGroups": [ # The list of ad groups. This list will be absent if empty. { # A single ad group associated with a line item. - "adGroupFormat": "A String", # Required. The format of the ads in the ad group. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1201,7 +1204,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1220,6 +1223,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, }, ], @@ -1252,7 +1256,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1297,7 +1301,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1316,6 +1320,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, } @@ -1329,7 +1334,7 @@

Method Details

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. + "adGroupFormat": "A String", # Required. Immutable. 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. @@ -1374,7 +1379,7 @@

Method Details

}, "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. + "lineItemId": "A String", # Required. Immutable. 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. @@ -1393,6 +1398,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, } diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html index 5ed54a8012..6c537a0d74 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html @@ -1037,6 +1037,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1305,6 +1306,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1533,6 +1535,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1816,6 +1819,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2057,6 +2061,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2305,6 +2310,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2534,6 +2540,7 @@

Method Details

"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`. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index a83407bbb8..46574fafee 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -7981,7 +7981,7 @@ } } }, -"revision": "20260305", +"revision": "20260312", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -9912,7 +9912,8 @@ "GEO_REGION_TYPE_QUARTER", "GEO_REGION_TYPE_DIVISION", "GEO_REGION_TYPE_COMMUNE", -"GEO_REGION_TYPE_COLLOQUIAL_AREA" +"GEO_REGION_TYPE_COLLOQUIAL_AREA", +"GEO_REGION_TYPE_POST_TOWN" ], "enumDescriptions": [ "The geographic region type is unknown.", @@ -9952,7 +9953,8 @@ "The geographic region is a quarter.", "The geographic region is a division.", "The geographic region is a commune.", -"The geographic region is a colloquial area." +"The geographic region is a colloquial area.", +"The geographic region is a post town." ], "readOnly": true, "type": "string" @@ -13829,7 +13831,8 @@ false "GEO_REGION_TYPE_QUARTER", "GEO_REGION_TYPE_DIVISION", "GEO_REGION_TYPE_COMMUNE", -"GEO_REGION_TYPE_COLLOQUIAL_AREA" +"GEO_REGION_TYPE_COLLOQUIAL_AREA", +"GEO_REGION_TYPE_POST_TOWN" ], "enumDescriptions": [ "The geographic region type is unknown.", @@ -13869,7 +13872,8 @@ false "The geographic region is a quarter.", "The geographic region is a division.", "The geographic region is a commune.", -"The geographic region is a colloquial area." +"The geographic region is a colloquial area.", +"The geographic region is a post town." ], "readOnly": true, "type": "string" @@ -13945,7 +13949,8 @@ false "GEO_REGION_TYPE_QUARTER", "GEO_REGION_TYPE_DIVISION", "GEO_REGION_TYPE_COMMUNE", -"GEO_REGION_TYPE_COLLOQUIAL_AREA" +"GEO_REGION_TYPE_COLLOQUIAL_AREA", +"GEO_REGION_TYPE_POST_TOWN" ], "enumDescriptions": [ "The geographic region type is unknown.", @@ -13985,7 +13990,8 @@ false "The geographic region is a quarter.", "The geographic region is a division.", "The geographic region is a commune.", -"The geographic region is a colloquial area." +"The geographic region is a colloquial area.", +"The geographic region is a post town." ], "readOnly": true, "type": "string" @@ -18731,6 +18737,10 @@ false "description": "Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.", "id": "TargetingExpansionConfig", "properties": { +"excludeDemographicExpansion": { +"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups.", +"type": "boolean" +}, "excludeFirstPartyAudience": { "deprecated": true, "description": "Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences.", diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index e0c57bb67b..1a2e8464c8 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -8706,7 +8706,7 @@ } } }, -"revision": "20260305", +"revision": "20260312", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -8829,7 +8829,7 @@ "id": "AdGroup", "properties": { "adGroupFormat": { -"description": "Required. The format of the ads in the ad group.", +"description": "Required. Immutable. The format of the ads in the ad group.", "enum": [ "AD_GROUP_FORMAT_UNSPECIFIED", "AD_GROUP_FORMAT_IN_STREAM", @@ -8901,7 +8901,7 @@ "type": "string" }, "lineItemId": { -"description": "Required. The unique ID of the line item that the ad group belongs to.", +"description": "Required. Immutable. The unique ID of the line item that the ad group belongs to.", "format": "int64", "type": "string" }, @@ -8932,7 +8932,7 @@ "type": "string" }, "adGroupId": { -"description": "Required. The unique ID of the ad group that the ad belongs to.", +"description": "Required. Immutable. The unique ID of the ad group that the ad belongs to.", "format": "int64", "type": "string" }, @@ -12445,7 +12445,8 @@ "GEO_REGION_TYPE_QUARTER", "GEO_REGION_TYPE_DIVISION", "GEO_REGION_TYPE_COMMUNE", -"GEO_REGION_TYPE_COLLOQUIAL_AREA" +"GEO_REGION_TYPE_COLLOQUIAL_AREA", +"GEO_REGION_TYPE_POST_TOWN" ], "enumDescriptions": [ "The geographic region type is unknown.", @@ -12485,7 +12486,8 @@ "The geographic region is a quarter.", "The geographic region is a division.", "The geographic region is a commune.", -"The geographic region is a colloquial area." +"The geographic region is a colloquial area.", +"The geographic region is a post town." ], "readOnly": true, "type": "string" @@ -17412,7 +17414,8 @@ false "GEO_REGION_TYPE_QUARTER", "GEO_REGION_TYPE_DIVISION", "GEO_REGION_TYPE_COMMUNE", -"GEO_REGION_TYPE_COLLOQUIAL_AREA" +"GEO_REGION_TYPE_COLLOQUIAL_AREA", +"GEO_REGION_TYPE_POST_TOWN" ], "enumDescriptions": [ "The geographic region type is unknown.", @@ -17452,7 +17455,8 @@ false "The geographic region is a quarter.", "The geographic region is a division.", "The geographic region is a commune.", -"The geographic region is a colloquial area." +"The geographic region is a colloquial area.", +"The geographic region is a post town." ], "readOnly": true, "type": "string" @@ -17528,7 +17532,8 @@ false "GEO_REGION_TYPE_QUARTER", "GEO_REGION_TYPE_DIVISION", "GEO_REGION_TYPE_COMMUNE", -"GEO_REGION_TYPE_COLLOQUIAL_AREA" +"GEO_REGION_TYPE_COLLOQUIAL_AREA", +"GEO_REGION_TYPE_POST_TOWN" ], "enumDescriptions": [ "The geographic region type is unknown.", @@ -17568,7 +17573,8 @@ false "The geographic region is a quarter.", "The geographic region is a division.", "The geographic region is a commune.", -"The geographic region is a colloquial area." +"The geographic region is a colloquial area.", +"The geographic region is a post town." ], "readOnly": true, "type": "string" @@ -22505,6 +22511,10 @@ false "enableOptimizedTargeting": { "description": "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`.", "type": "boolean" +}, +"excludeDemographicExpansion": { +"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups.", +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index 6ca86cc5bb..0877bb669c 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -9363,7 +9363,7 @@ } } }, -"revision": "20260305", +"revision": "20260312", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9542,7 +9542,7 @@ "id": "AdGroup", "properties": { "adGroupFormat": { -"description": "Required. The format of the ads in the ad group.", +"description": "Required. Immutable. The format of the ads in the ad group.", "enum": [ "AD_GROUP_FORMAT_UNSPECIFIED", "AD_GROUP_FORMAT_IN_STREAM", @@ -9614,7 +9614,7 @@ "type": "string" }, "lineItemId": { -"description": "Required. The unique ID of the line item that the ad group belongs to.", +"description": "Required. Immutable. The unique ID of the line item that the ad group belongs to.", "format": "int64", "type": "string" }, @@ -9645,7 +9645,7 @@ "type": "string" }, "adGroupId": { -"description": "Required. The unique ID of the ad group that the ad belongs to.", +"description": "Required. Immutable. The unique ID of the ad group that the ad belongs to.", "format": "int64", "type": "string" }, @@ -13186,7 +13186,8 @@ "GEO_REGION_TYPE_QUARTER", "GEO_REGION_TYPE_DIVISION", "GEO_REGION_TYPE_COMMUNE", -"GEO_REGION_TYPE_COLLOQUIAL_AREA" +"GEO_REGION_TYPE_COLLOQUIAL_AREA", +"GEO_REGION_TYPE_POST_TOWN" ], "enumDescriptions": [ "The geographic region type is unknown.", @@ -13226,7 +13227,8 @@ "The geographic region is a quarter.", "The geographic region is a division.", "The geographic region is a commune.", -"The geographic region is a colloquial area." +"The geographic region is a colloquial area.", +"The geographic region is a post town." ], "readOnly": true, "type": "string" @@ -18176,7 +18178,8 @@ false "GEO_REGION_TYPE_QUARTER", "GEO_REGION_TYPE_DIVISION", "GEO_REGION_TYPE_COMMUNE", -"GEO_REGION_TYPE_COLLOQUIAL_AREA" +"GEO_REGION_TYPE_COLLOQUIAL_AREA", +"GEO_REGION_TYPE_POST_TOWN" ], "enumDescriptions": [ "The geographic region type is unknown.", @@ -18216,7 +18219,8 @@ false "The geographic region is a quarter.", "The geographic region is a division.", "The geographic region is a commune.", -"The geographic region is a colloquial area." +"The geographic region is a colloquial area.", +"The geographic region is a post town." ], "readOnly": true, "type": "string" @@ -18292,7 +18296,8 @@ false "GEO_REGION_TYPE_QUARTER", "GEO_REGION_TYPE_DIVISION", "GEO_REGION_TYPE_COMMUNE", -"GEO_REGION_TYPE_COLLOQUIAL_AREA" +"GEO_REGION_TYPE_COLLOQUIAL_AREA", +"GEO_REGION_TYPE_POST_TOWN" ], "enumDescriptions": [ "The geographic region type is unknown.", @@ -18332,7 +18337,8 @@ false "The geographic region is a quarter.", "The geographic region is a division.", "The geographic region is a commune.", -"The geographic region is a colloquial area." +"The geographic region is a colloquial area.", +"The geographic region is a post town." ], "readOnly": true, "type": "string" @@ -23239,6 +23245,10 @@ false "enableOptimizedTargeting": { "description": "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`.", "type": "boolean" +}, +"excludeDemographicExpansion": { +"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups.", +"type": "boolean" } }, "type": "object" From b538e2ec1463b95f01fb3fad110b521085b92ea4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 21/31] feat(drive): update the api #### drive:v2 The following keys were added: - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.deprecated (Total Keys: 1) - resources.permissions.methods.insert.parameters.enforceExpansiveAccess.deprecated (Total Keys: 1) - resources.permissions.methods.patch.parameters.enforceExpansiveAccess.deprecated (Total Keys: 1) - resources.permissions.methods.update.parameters.enforceExpansiveAccess.deprecated (Total Keys: 1) #### drive:v3 The following keys were added: - resources.permissions.methods.create.parameters.enforceExpansiveAccess.deprecated (Total Keys: 1) - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.deprecated (Total Keys: 1) - resources.permissions.methods.update.parameters.enforceExpansiveAccess.deprecated (Total Keys: 1) --- docs/dyn/drive_v2.permissions.html | 8 ++++---- docs/dyn/drive_v3.permissions.html | 6 +++--- .../discovery_cache/documents/drive.v2.json | 14 +++++++++----- .../discovery_cache/documents/drive.v3.json | 11 +++++++---- 4 files changed, 23 insertions(+), 16 deletions(-) diff --git a/docs/dyn/drive_v2.permissions.html b/docs/dyn/drive_v2.permissions.html index 782cfd296e..673ccd884a 100644 --- a/docs/dyn/drive_v2.permissions.html +++ b/docs/dyn/drive_v2.permissions.html @@ -114,7 +114,7 @@

Method Details

Args: fileId: string, The ID for the file or shared drive. (required) permissionId: string, The ID for the permission. (required) - enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. + enforceExpansiveAccess: boolean, Deprecated: All requests use the expansive access rules. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. @@ -266,7 +266,7 @@

Method Details

} emailMessage: string, A plain text custom message to include in notification emails. - enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. + enforceExpansiveAccess: boolean, Deprecated: All requests use the expansive access rules. enforceSingleParent: boolean, Deprecated: See `moveToNewOwnersRoot` for details. moveToNewOwnersRoot: boolean, This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed. sendNotificationEmails: boolean, Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the `role` is `owner`. @@ -473,7 +473,7 @@

Method Details

"withLink": True or False, # Whether the link is required for this permission. } - enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. + enforceExpansiveAccess: boolean, Deprecated: All requests use the expansive access rules. removeExpiration: boolean, Whether to remove the expiration date. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. @@ -590,7 +590,7 @@

Method Details

"withLink": True or False, # Whether the link is required for this permission. } - enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. + enforceExpansiveAccess: boolean, Deprecated: All requests use the expansive access rules. removeExpiration: boolean, Whether to remove the expiration date. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. diff --git a/docs/dyn/drive_v3.permissions.html b/docs/dyn/drive_v3.permissions.html index 452bd0111d..0f69e63ad8 100644 --- a/docs/dyn/drive_v3.permissions.html +++ b/docs/dyn/drive_v3.permissions.html @@ -144,7 +144,7 @@

Method Details

} emailMessage: string, A plain text custom message to include in the notification email. - enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. + enforceExpansiveAccess: boolean, Deprecated: All requests use the expansive access rules. enforceSingleParent: boolean, Deprecated: See `moveToNewOwnersRoot` for details. moveToNewOwnersRoot: boolean, This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents aren't changed. sendNotificationEmail: boolean, Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. @@ -201,7 +201,7 @@

Method Details

Args: fileId: string, The ID of the file or shared drive. (required) permissionId: string, The ID of the permission. (required) - enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. + enforceExpansiveAccess: boolean, Deprecated: All requests use the expansive access rules. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. useDomainAdminAccess: boolean, Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators). @@ -381,7 +381,7 @@

Method Details

"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). } - enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. + enforceExpansiveAccess: boolean, Deprecated: All requests use the expansive access rules. removeExpiration: boolean, Whether to remove the expiration date. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 53daaad384..5b44fa1657 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -2634,7 +2634,8 @@ "parameters": { "enforceExpansiveAccess": { "default": "false", -"description": "Whether the request should enforce expansive access rules.", +"deprecated": true, +"description": "Deprecated: All requests use the expansive access rules.", "location": "query", "type": "boolean" }, @@ -2779,7 +2780,8 @@ }, "enforceExpansiveAccess": { "default": "false", -"description": "Whether the request should enforce expansive access rules.", +"deprecated": true, +"description": "Deprecated: All requests use the expansive access rules.", "location": "query", "type": "boolean" }, @@ -2919,7 +2921,8 @@ "parameters": { "enforceExpansiveAccess": { "default": "false", -"description": "Whether the request should enforce expansive access rules.", +"deprecated": true, +"description": "Deprecated: All requests use the expansive access rules.", "location": "query", "type": "boolean" }, @@ -2991,7 +2994,8 @@ "parameters": { "enforceExpansiveAccess": { "default": "false", -"description": "Whether the request should enforce expansive access rules.", +"deprecated": true, +"description": "Deprecated: All requests use the expansive access rules.", "location": "query", "type": "boolean" }, @@ -3893,7 +3897,7 @@ } } }, -"revision": "20260118", +"revision": "20260305", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 33714231c4..f209ef721a 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -1945,7 +1945,8 @@ }, "enforceExpansiveAccess": { "default": "false", -"description": "Whether the request should enforce expansive access rules.", +"deprecated": true, +"description": "Deprecated: All requests use the expansive access rules.", "location": "query", "type": "boolean" }, @@ -2023,7 +2024,8 @@ "parameters": { "enforceExpansiveAccess": { "default": "false", -"description": "Whether the request should enforce expansive access rules.", +"deprecated": true, +"description": "Deprecated: All requests use the expansive access rules.", "location": "query", "type": "boolean" }, @@ -2200,7 +2202,8 @@ "parameters": { "enforceExpansiveAccess": { "default": "false", -"description": "Whether the request should enforce expansive access rules.", +"deprecated": true, +"description": "Deprecated: All requests use the expansive access rules.", "location": "query", "type": "boolean" }, @@ -2800,7 +2803,7 @@ } } }, -"revision": "20260220", +"revision": "20260305", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { From 242ee76b2de143a24959021e6a3a75685a878aec Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 22/31] feat(fcm): update the api #### fcm:v1 The following keys were deleted: - schemas.AndroidNotification.properties.bypassProxyNotification (Total Keys: 2) --- docs/dyn/fcm_v1.projects.messages.html | 10 ++++------ googleapiclient/discovery_cache/documents/fcm.v1.json | 11 +++-------- 2 files changed, 7 insertions(+), 14 deletions(-) diff --git a/docs/dyn/fcm_v1.projects.messages.html b/docs/dyn/fcm_v1.projects.messages.html index d4dc8661e1..465dd37a5a 100644 --- a/docs/dyn/fcm_v1.projects.messages.html +++ b/docs/dyn/fcm_v1.projects.messages.html @@ -113,7 +113,6 @@

Method Details

"A String", ], "bodyLocKey": "A String", # The key to the body string in the app's string resources to use to localize the body text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. - "bypassProxyNotification": True or False, # If set, display notifications delivered to the device will be handled by the app instead of the proxy. "channelId": "A String", # The [notification's channel id](https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels) (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID is received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest. "clickAction": "A String", # The action associated with a user click on the notification. If specified, an activity with a matching intent filter is launched when a user clicks on the notification. "color": "A String", # The notification's icon color, expressed in #rrggbb format. @@ -135,7 +134,7 @@

Method Details

}, "localOnly": True or False, # Set whether or not this notification is relevant only to the current device. Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this notification not be bridged. See [Wear OS guides](https://developer.android.com/training/wearables/notifications/bridger#existing-method-of-preventing-bridging) "notificationCount": 42, # Sets the number of items this notification represents. May be displayed as a badge count for launchers that support badging.See [Notification Badge](https://developer.android.com/training/notify-user/badges). For example, this might be useful if you're using just one notification to represent multiple new messages but you want the count here to represent the number of total new messages. If zero or unspecified, systems that support badging use the default, which is to increment a number displayed on the long-press menu each time a new notification arrives. - "notificationPriority": "A String", # Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. The effect of setting the same priorities may differ slightly on different platforms. Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered. + "notificationPriority": "A String", # Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. This parameter affects notification priority only on devices running Android 7.1 (API level 25) and lower. On Android 8.0 (API level 26) and higher, priority is ignored in favor of channel [importance](https://developer.android.com/develop/ui/views/notifications/channels#importance). Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered. "proxy": "A String", # Setting to control when a notification may be proxied. "sound": "A String", # The sound to play when the device receives the notification. Supports "default" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/. "sticky": True or False, # When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it. @@ -151,7 +150,7 @@

Method Details

], "visibility": "A String", # Set the [Notification.visibility](https://developer.android.com/reference/android/app/Notification.html#visibility) of the notification. }, - "priority": "A String", # Message priority. Can take "normal" and "high" values. For more information, see [Setting the priority of a message](https://goo.gl/GjONJv). + "priority": "A String", # Message priority. Can take "normal" and "high" values. For more information, see [Setting the priority of a message](https://firebase.google.com/docs/cloud-messaging/customize-messages/setting-message-priority). "restrictedPackageName": "A String", # Package name of the application where the registration token must match in order to receive the message. "restrictedSatelliteOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is connected over a restricted satellite network. This should only be enabled for messages that can be handled over a restricted satellite network and only for apps that are enabled to work over a restricted satellite network. Note that the ability of the app to connect to a restricted satellite network is dependent on the carrier's settings and the device model. "ttl": "A String", # How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. @@ -228,7 +227,6 @@

Method Details

"A String", ], "bodyLocKey": "A String", # The key to the body string in the app's string resources to use to localize the body text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. - "bypassProxyNotification": True or False, # If set, display notifications delivered to the device will be handled by the app instead of the proxy. "channelId": "A String", # The [notification's channel id](https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels) (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID is received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest. "clickAction": "A String", # The action associated with a user click on the notification. If specified, an activity with a matching intent filter is launched when a user clicks on the notification. "color": "A String", # The notification's icon color, expressed in #rrggbb format. @@ -250,7 +248,7 @@

Method Details

}, "localOnly": True or False, # Set whether or not this notification is relevant only to the current device. Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this notification not be bridged. See [Wear OS guides](https://developer.android.com/training/wearables/notifications/bridger#existing-method-of-preventing-bridging) "notificationCount": 42, # Sets the number of items this notification represents. May be displayed as a badge count for launchers that support badging.See [Notification Badge](https://developer.android.com/training/notify-user/badges). For example, this might be useful if you're using just one notification to represent multiple new messages but you want the count here to represent the number of total new messages. If zero or unspecified, systems that support badging use the default, which is to increment a number displayed on the long-press menu each time a new notification arrives. - "notificationPriority": "A String", # Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. The effect of setting the same priorities may differ slightly on different platforms. Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered. + "notificationPriority": "A String", # Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. This parameter affects notification priority only on devices running Android 7.1 (API level 25) and lower. On Android 8.0 (API level 26) and higher, priority is ignored in favor of channel [importance](https://developer.android.com/develop/ui/views/notifications/channels#importance). Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered. "proxy": "A String", # Setting to control when a notification may be proxied. "sound": "A String", # The sound to play when the device receives the notification. Supports "default" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/. "sticky": True or False, # When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it. @@ -266,7 +264,7 @@

Method Details

], "visibility": "A String", # Set the [Notification.visibility](https://developer.android.com/reference/android/app/Notification.html#visibility) of the notification. }, - "priority": "A String", # Message priority. Can take "normal" and "high" values. For more information, see [Setting the priority of a message](https://goo.gl/GjONJv). + "priority": "A String", # Message priority. Can take "normal" and "high" values. For more information, see [Setting the priority of a message](https://firebase.google.com/docs/cloud-messaging/customize-messages/setting-message-priority). "restrictedPackageName": "A String", # Package name of the application where the registration token must match in order to receive the message. "restrictedSatelliteOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is connected over a restricted satellite network. This should only be enabled for messages that can be handled over a restricted satellite network and only for apps that are enabled to work over a restricted satellite network. Note that the ability of the app to connect to a restricted satellite network is dependent on the carrier's settings and the device model. "ttl": "A String", # How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. diff --git a/googleapiclient/discovery_cache/documents/fcm.v1.json b/googleapiclient/discovery_cache/documents/fcm.v1.json index 59d77646bc..7cc5cd7526 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20260130", +"revision": "20260306", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { @@ -181,7 +181,7 @@ "description": "Notification to send to android devices." }, "priority": { -"description": "Message priority. Can take \"normal\" and \"high\" values. For more information, see [Setting the priority of a message](https://goo.gl/GjONJv).", +"description": "Message priority. Can take \"normal\" and \"high\" values. For more information, see [Setting the priority of a message](https://firebase.google.com/docs/cloud-messaging/customize-messages/setting-message-priority).", "enum": [ "NORMAL", "HIGH" @@ -238,11 +238,6 @@ "description": "The key to the body string in the app's string resources to use to localize the body text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information.", "type": "string" }, -"bypassProxyNotification": { -"deprecated": true, -"description": "If set, display notifications delivered to the device will be handled by the app instead of the proxy.", -"type": "boolean" -}, "channelId": { "description": "The [notification's channel id](https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels) (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID is received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest.", "type": "string" @@ -294,7 +289,7 @@ "type": "integer" }, "notificationPriority": { -"description": "Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. The effect of setting the same priorities may differ slightly on different platforms. Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered.", +"description": "Set the relative priority for this notification. Priority is an indication of how much of the user's attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. This parameter affects notification priority only on devices running Android 7.1 (API level 25) and lower. On Android 8.0 (API level 26) and higher, priority is ignored in favor of channel [importance](https://developer.android.com/develop/ui/views/notifications/channels#importance). Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered.", "enum": [ "PRIORITY_UNSPECIFIED", "PRIORITY_MIN", From 44b794c39ef2e2f9b16fbcdb6bb78dc20477db42 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 23/31] feat(iam): update the api #### iam:v1 The following keys were added: - schemas.InlineCertificateIssuanceConfig.properties.useDefaultSharedCa.type (Total Keys: 1) - schemas.TrustStore.properties.trustDefaultSharedCa.type (Total Keys: 1) --- ...am_v1.projects.locations.workloadIdentityPools.html | 8 ++++++++ ...ects.locations.workloadIdentityPools.providers.html | 4 ++++ googleapiclient/discovery_cache/documents/iam.v1.json | 10 +++++++++- 3 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.html b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.html index 451a229bb4..be17be5ca4 100644 --- a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.html +++ b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.html @@ -149,6 +149,7 @@

Method Details

"keyAlgorithm": "A String", # Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If not specified, this will default to ECDSA_P256. "lifetime": "A String", # Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 24 hours and 30 days. If not specified, this will be defaulted to 24 hours. "rotationWindowPercentage": 42, # Optional. Rotation window percentage, the percentage of remaining lifetime after which certificate rotation is initiated. Must be between 50 and 80. If no value is specified, rotation window percentage is defaulted to 50. + "useDefaultSharedCa": True or False, # Optional. If set to true, the trust domain will utilize the GCP-provisioned default CA. A default CA in the same region as the workload will be selected to issue the certificate. Enabling this will clear any existing `ca_pools` configuration to provision the certificates. NOTE: This field is mutually exclusive with `ca_pools`. If this flag is enabled, certificates will be automatically provisioned from the default shared CAs. This flag should not be set if you want to use your own CA pools to provision the certificates. }, "inlineTrustConfig": { # Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration. # Optional. Represents config to add additional trusted trust domains. "additionalTrustBundles": { # Optional. Maps specific trust domains (e.g., "example.com") to their corresponding TrustStore, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the trust bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools. @@ -163,6 +164,7 @@

Method Details

"pemCertificate": "A String", # PEM certificate of the PKI used for validation. Must only contain one ca certificate (either root or intermediate cert). }, ], + "trustDefaultSharedCa": True or False, # Optional. If set to True, the trust bundle will include the private ca managed identity regional root public certificates. Important: `trust_default_shared_ca` is only supported for managed identity trust domain resource. }, }, }, @@ -262,6 +264,7 @@

Method Details

"keyAlgorithm": "A String", # Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If not specified, this will default to ECDSA_P256. "lifetime": "A String", # Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 24 hours and 30 days. If not specified, this will be defaulted to 24 hours. "rotationWindowPercentage": 42, # Optional. Rotation window percentage, the percentage of remaining lifetime after which certificate rotation is initiated. Must be between 50 and 80. If no value is specified, rotation window percentage is defaulted to 50. + "useDefaultSharedCa": True or False, # Optional. If set to true, the trust domain will utilize the GCP-provisioned default CA. A default CA in the same region as the workload will be selected to issue the certificate. Enabling this will clear any existing `ca_pools` configuration to provision the certificates. NOTE: This field is mutually exclusive with `ca_pools`. If this flag is enabled, certificates will be automatically provisioned from the default shared CAs. This flag should not be set if you want to use your own CA pools to provision the certificates. }, "inlineTrustConfig": { # Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration. # Optional. Represents config to add additional trusted trust domains. "additionalTrustBundles": { # Optional. Maps specific trust domains (e.g., "example.com") to their corresponding TrustStore, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the trust bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools. @@ -276,6 +279,7 @@

Method Details

"pemCertificate": "A String", # PEM certificate of the PKI used for validation. Must only contain one ca certificate (either root or intermediate cert). }, ], + "trustDefaultSharedCa": True or False, # Optional. If set to True, the trust bundle will include the private ca managed identity regional root public certificates. Important: `trust_default_shared_ca` is only supported for managed identity trust domain resource. }, }, }, @@ -373,6 +377,7 @@

Method Details

"keyAlgorithm": "A String", # Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If not specified, this will default to ECDSA_P256. "lifetime": "A String", # Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 24 hours and 30 days. If not specified, this will be defaulted to 24 hours. "rotationWindowPercentage": 42, # Optional. Rotation window percentage, the percentage of remaining lifetime after which certificate rotation is initiated. Must be between 50 and 80. If no value is specified, rotation window percentage is defaulted to 50. + "useDefaultSharedCa": True or False, # Optional. If set to true, the trust domain will utilize the GCP-provisioned default CA. A default CA in the same region as the workload will be selected to issue the certificate. Enabling this will clear any existing `ca_pools` configuration to provision the certificates. NOTE: This field is mutually exclusive with `ca_pools`. If this flag is enabled, certificates will be automatically provisioned from the default shared CAs. This flag should not be set if you want to use your own CA pools to provision the certificates. }, "inlineTrustConfig": { # Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration. # Optional. Represents config to add additional trusted trust domains. "additionalTrustBundles": { # Optional. Maps specific trust domains (e.g., "example.com") to their corresponding TrustStore, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the trust bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools. @@ -387,6 +392,7 @@

Method Details

"pemCertificate": "A String", # PEM certificate of the PKI used for validation. Must only contain one ca certificate (either root or intermediate cert). }, ], + "trustDefaultSharedCa": True or False, # Optional. If set to True, the trust bundle will include the private ca managed identity regional root public certificates. Important: `trust_default_shared_ca` is only supported for managed identity trust domain resource. }, }, }, @@ -433,6 +439,7 @@

Method Details

"keyAlgorithm": "A String", # Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If not specified, this will default to ECDSA_P256. "lifetime": "A String", # Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 24 hours and 30 days. If not specified, this will be defaulted to 24 hours. "rotationWindowPercentage": 42, # Optional. Rotation window percentage, the percentage of remaining lifetime after which certificate rotation is initiated. Must be between 50 and 80. If no value is specified, rotation window percentage is defaulted to 50. + "useDefaultSharedCa": True or False, # Optional. If set to true, the trust domain will utilize the GCP-provisioned default CA. A default CA in the same region as the workload will be selected to issue the certificate. Enabling this will clear any existing `ca_pools` configuration to provision the certificates. NOTE: This field is mutually exclusive with `ca_pools`. If this flag is enabled, certificates will be automatically provisioned from the default shared CAs. This flag should not be set if you want to use your own CA pools to provision the certificates. }, "inlineTrustConfig": { # Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration. # Optional. Represents config to add additional trusted trust domains. "additionalTrustBundles": { # Optional. Maps specific trust domains (e.g., "example.com") to their corresponding TrustStore, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the trust bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools. @@ -447,6 +454,7 @@

Method Details

"pemCertificate": "A String", # PEM certificate of the PKI used for validation. Must only contain one ca certificate (either root or intermediate cert). }, ], + "trustDefaultSharedCa": True or False, # Optional. If set to True, the trust bundle will include the private ca managed identity regional root public certificates. Important: `trust_default_shared_ca` is only supported for managed identity trust domain resource. }, }, }, diff --git a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html index b744c995e5..5aaaafbb3d 100644 --- a/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html +++ b/docs/dyn/iam_v1.projects.locations.workloadIdentityPools.providers.html @@ -159,6 +159,7 @@

Method Details

"pemCertificate": "A String", # PEM certificate of the PKI used for validation. Must only contain one ca certificate (either root or intermediate cert). }, ], + "trustDefaultSharedCa": True or False, # Optional. If set to True, the trust bundle will include the private ca managed identity regional root public certificates. Important: `trust_default_shared_ca` is only supported for managed identity trust domain resource. }, }, } @@ -278,6 +279,7 @@

Method Details

"pemCertificate": "A String", # PEM certificate of the PKI used for validation. Must only contain one ca certificate (either root or intermediate cert). }, ], + "trustDefaultSharedCa": True or False, # Optional. If set to True, the trust bundle will include the private ca managed identity regional root public certificates. Important: `trust_default_shared_ca` is only supported for managed identity trust domain resource. }, }, } @@ -339,6 +341,7 @@

Method Details

"pemCertificate": "A String", # PEM certificate of the PKI used for validation. Must only contain one ca certificate (either root or intermediate cert). }, ], + "trustDefaultSharedCa": True or False, # Optional. If set to True, the trust bundle will include the private ca managed identity regional root public certificates. Important: `trust_default_shared_ca` is only supported for managed identity trust domain resource. }, }, }, @@ -405,6 +408,7 @@

Method Details

"pemCertificate": "A String", # PEM certificate of the PKI used for validation. Must only contain one ca certificate (either root or intermediate cert). }, ], + "trustDefaultSharedCa": True or False, # Optional. If set to True, the trust bundle will include the private ca managed identity regional root public certificates. Important: `trust_default_shared_ca` is only supported for managed identity trust domain resource. }, }, } diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index 7114979375..5b43d82a4c 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -4160,7 +4160,7 @@ } } }, -"revision": "20260227", +"revision": "20260306", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4734,6 +4734,10 @@ "description": "Optional. Rotation window percentage, the percentage of remaining lifetime after which certificate rotation is initiated. Must be between 50 and 80. If no value is specified, rotation window percentage is defaulted to 50.", "format": "int32", "type": "integer" +}, +"useDefaultSharedCa": { +"description": "Optional. If set to true, the trust domain will utilize the GCP-provisioned default CA. A default CA in the same region as the workload will be selected to issue the certificate. Enabling this will clear any existing `ca_pools` configuration to provision the certificates. NOTE: This field is mutually exclusive with `ca_pools`. If this flag is enabled, certificates will be automatically provisioned from the default shared CAs. This flag should not be set if you want to use your own CA pools to provision the certificates.", +"type": "boolean" } }, "type": "object" @@ -6124,6 +6128,10 @@ false "$ref": "TrustAnchor" }, "type": "array" +}, +"trustDefaultSharedCa": { +"description": "Optional. If set to True, the trust bundle will include the private ca managed identity regional root public certificates. Important: `trust_default_shared_ca` is only supported for managed identity trust domain resource.", +"type": "boolean" } }, "type": "object" From 54b06e5eceeb875513d96efd0d650f13ab938040 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 24/31] feat(migrationcenter): update the api #### migrationcenter:v1alpha1 The following keys were added: - schemas.Asset.properties.awsApiGatewayRestApiDetails (Total Keys: 2) - schemas.Asset.properties.awsAppSyncGraphqlApiDetails (Total Keys: 2) - schemas.Asset.properties.awsApplicationLoadBalancerDetails (Total Keys: 2) - schemas.Asset.properties.awsAutoscalingGroupDetails (Total Keys: 2) - schemas.Asset.properties.awsBatchComputeEnvironmentDetails (Total Keys: 2) - schemas.Asset.properties.awsEbsVolumeDetails (Total Keys: 2) - schemas.Asset.properties.awsEcrRepositoryDetails (Total Keys: 2) - schemas.Asset.properties.awsElasticIpAddressDetails (Total Keys: 2) - schemas.Asset.properties.awsElasticNetworkInterfaceDetails (Total Keys: 2) - schemas.Asset.properties.awsInternetGatewayDetails (Total Keys: 2) - schemas.Asset.properties.awsSnsTopicDetails (Total Keys: 2) - schemas.AssetFrame.properties.awsApiGatewayRestApiDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsAppSyncGraphqlApiDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsApplicationLoadBalancerDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsAutoscalingGroupDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsBatchComputeEnvironmentDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsEbsVolumeDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsEcrRepositoryDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsElasticIpAddressDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsElasticNetworkInterfaceDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsInternetGatewayDetails.$ref (Total Keys: 1) - schemas.AssetFrame.properties.awsSnsTopicDetails.$ref (Total Keys: 1) - schemas.AwsApiGatewayRestApiDetails (Total Keys: 2) - schemas.AwsAppSyncGraphqlApiDetails (Total Keys: 2) - schemas.AwsApplicationLoadBalancerDetails (Total Keys: 2) - schemas.AwsAutoscalingGroupDetails (Total Keys: 2) - schemas.AwsBatchComputeEnvironmentDetails (Total Keys: 2) - schemas.AwsEbsVolumeDetails (Total Keys: 2) - schemas.AwsEcrRepositoryDetails (Total Keys: 2) - schemas.AwsElasticIpAddressDetails (Total Keys: 2) - schemas.AwsElasticNetworkInterfaceDetails (Total Keys: 2) - schemas.AwsInternetGatewayDetails (Total Keys: 2) - schemas.AwsSnsTopicDetails (Total Keys: 2) - schemas.EstimatedUsage (Total Keys: 8) - schemas.VirtualMachinePreferences.properties.estimatedUsage.$ref (Total Keys: 1) --- ...er_v1alpha1.projects.locations.assets.html | 154 +++++++++++++ ...ha1.projects.locations.preferenceSets.html | 20 ++ ...jects.locations.reportConfigs.reports.html | 78 +++++++ ...rojects.locations.sources.errorFrames.html | 44 ++++ .../documents/migrationcenter.v1alpha1.json | 217 +++++++++++++++++- 5 files changed, 512 insertions(+), 1 deletion(-) diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html index 6b5b4979f5..9312247afd 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html @@ -225,18 +225,38 @@

Method Details

"attributes": { # Generic asset attributes. "a_key": "A String", }, + "awsApiGatewayRestApiDetails": { # Asset information specific for AWS API Gateway REST APIs. # Output only. Asset information specific for AWS API Gateway REST APIs. + }, + "awsAppSyncGraphqlApiDetails": { # Asset information specific for AWS AppSync GraphQL APIs. # Output only. Asset information specific for AWS AppSync GraphQL APIs. + }, + "awsApplicationLoadBalancerDetails": { # Asset information specific for AWS Application Load Balancers. # Output only. Asset information specific for AWS Application Load Balancers. + }, + "awsAutoscalingGroupDetails": { # Asset information specific for AWS Autoscaling Group. # Output only. Asset information specific for AwsAutoscalingGroupDetails + }, + "awsBatchComputeEnvironmentDetails": { # Asset information specific for AWS Batch Compute Environments. # Output only. Asset information specific for AWS Batch Compute Environments. + }, "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions. }, "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables. }, + "awsEbsVolumeDetails": { # Asset information specific for AWS EBS Volumes. # Output only. Asset information specific for AWS EBS Volumes. + }, + "awsEcrRepositoryDetails": { # Asset information specific for AWS ECR Repository. # Output only. Asset information specific for AwsEcrRepositoryDetails + }, "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters. }, "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems. }, "awsEksClusterDetails": { # Asset information specific for AWS EKS clusters. # Output only. Asset information specific for AWS EKS clusters. }, + "awsElasticIpAddressDetails": { # Asset information specific for AWS Elastic IP Addresses. # Output only. Asset information specific for AWS Elastic IP Addresses. + }, + "awsElasticNetworkInterfaceDetails": { # Asset information specific for AWS Elastic Network Interfaces. # Output only. Asset information specific for AWS Elastic Network Interfaces. + }, "awsElbLoadBalancerDetails": { # Asset information specific for AWS Load Balancers. # Output only. Asset information specific for AWS Load Balancers. }, + "awsInternetGatewayDetails": { # Asset information specific for AWS Internet Gateways. # Output only. Asset information specific for AWS Internet Gateways. + }, "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions. }, "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails @@ -261,6 +281,8 @@

Method Details

"enabled": True or False, # Optional. Whether versioning is enabled. }, }, + "awsSnsTopicDetails": { # Asset information specific for AWS SNS Topics. # Output only. Asset information specific for AWS SNS Topics. + }, "awsVpcDetails": { # Asset information specific for AWS VPCs. # Output only. Asset information specific for AWS VPCs. }, "createTime": "A String", # Output only. The timestamp when the asset was created. @@ -1289,18 +1311,38 @@

Method Details

"attributes": { # Generic asset attributes. "a_key": "A String", }, + "awsApiGatewayRestApiDetails": { # Asset information specific for AWS API Gateway REST APIs. # Output only. Asset information specific for AWS API Gateway REST APIs. + }, + "awsAppSyncGraphqlApiDetails": { # Asset information specific for AWS AppSync GraphQL APIs. # Output only. Asset information specific for AWS AppSync GraphQL APIs. + }, + "awsApplicationLoadBalancerDetails": { # Asset information specific for AWS Application Load Balancers. # Output only. Asset information specific for AWS Application Load Balancers. + }, + "awsAutoscalingGroupDetails": { # Asset information specific for AWS Autoscaling Group. # Output only. Asset information specific for AwsAutoscalingGroupDetails + }, + "awsBatchComputeEnvironmentDetails": { # Asset information specific for AWS Batch Compute Environments. # Output only. Asset information specific for AWS Batch Compute Environments. + }, "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions. }, "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables. }, + "awsEbsVolumeDetails": { # Asset information specific for AWS EBS Volumes. # Output only. Asset information specific for AWS EBS Volumes. + }, + "awsEcrRepositoryDetails": { # Asset information specific for AWS ECR Repository. # Output only. Asset information specific for AwsEcrRepositoryDetails + }, "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters. }, "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems. }, "awsEksClusterDetails": { # Asset information specific for AWS EKS clusters. # Output only. Asset information specific for AWS EKS clusters. }, + "awsElasticIpAddressDetails": { # Asset information specific for AWS Elastic IP Addresses. # Output only. Asset information specific for AWS Elastic IP Addresses. + }, + "awsElasticNetworkInterfaceDetails": { # Asset information specific for AWS Elastic Network Interfaces. # Output only. Asset information specific for AWS Elastic Network Interfaces. + }, "awsElbLoadBalancerDetails": { # Asset information specific for AWS Load Balancers. # Output only. Asset information specific for AWS Load Balancers. }, + "awsInternetGatewayDetails": { # Asset information specific for AWS Internet Gateways. # Output only. Asset information specific for AWS Internet Gateways. + }, "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions. }, "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails @@ -1325,6 +1367,8 @@

Method Details

"enabled": True or False, # Optional. Whether versioning is enabled. }, }, + "awsSnsTopicDetails": { # Asset information specific for AWS SNS Topics. # Output only. Asset information specific for AWS SNS Topics. + }, "awsVpcDetails": { # Asset information specific for AWS VPCs. # Output only. Asset information specific for AWS VPCs. }, "createTime": "A String", # Output only. The timestamp when the asset was created. @@ -2385,18 +2429,38 @@

Method Details

"attributes": { # Generic asset attributes. "a_key": "A String", }, + "awsApiGatewayRestApiDetails": { # Asset information specific for AWS API Gateway REST APIs. # Output only. Asset information specific for AWS API Gateway REST APIs. + }, + "awsAppSyncGraphqlApiDetails": { # Asset information specific for AWS AppSync GraphQL APIs. # Output only. Asset information specific for AWS AppSync GraphQL APIs. + }, + "awsApplicationLoadBalancerDetails": { # Asset information specific for AWS Application Load Balancers. # Output only. Asset information specific for AWS Application Load Balancers. + }, + "awsAutoscalingGroupDetails": { # Asset information specific for AWS Autoscaling Group. # Output only. Asset information specific for AwsAutoscalingGroupDetails + }, + "awsBatchComputeEnvironmentDetails": { # Asset information specific for AWS Batch Compute Environments. # Output only. Asset information specific for AWS Batch Compute Environments. + }, "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions. }, "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables. }, + "awsEbsVolumeDetails": { # Asset information specific for AWS EBS Volumes. # Output only. Asset information specific for AWS EBS Volumes. + }, + "awsEcrRepositoryDetails": { # Asset information specific for AWS ECR Repository. # Output only. Asset information specific for AwsEcrRepositoryDetails + }, "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters. }, "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems. }, "awsEksClusterDetails": { # Asset information specific for AWS EKS clusters. # Output only. Asset information specific for AWS EKS clusters. }, + "awsElasticIpAddressDetails": { # Asset information specific for AWS Elastic IP Addresses. # Output only. Asset information specific for AWS Elastic IP Addresses. + }, + "awsElasticNetworkInterfaceDetails": { # Asset information specific for AWS Elastic Network Interfaces. # Output only. Asset information specific for AWS Elastic Network Interfaces. + }, "awsElbLoadBalancerDetails": { # Asset information specific for AWS Load Balancers. # Output only. Asset information specific for AWS Load Balancers. }, + "awsInternetGatewayDetails": { # Asset information specific for AWS Internet Gateways. # Output only. Asset information specific for AWS Internet Gateways. + }, "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions. }, "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails @@ -2421,6 +2485,8 @@

Method Details

"enabled": True or False, # Optional. Whether versioning is enabled. }, }, + "awsSnsTopicDetails": { # Asset information specific for AWS SNS Topics. # Output only. Asset information specific for AWS SNS Topics. + }, "awsVpcDetails": { # Asset information specific for AWS VPCs. # Output only. Asset information specific for AWS VPCs. }, "createTime": "A String", # Output only. The timestamp when the asset was created. @@ -3462,18 +3528,38 @@

Method Details

"attributes": { # Generic asset attributes. "a_key": "A String", }, + "awsApiGatewayRestApiDetails": { # Asset information specific for AWS API Gateway REST APIs. # Output only. Asset information specific for AWS API Gateway REST APIs. + }, + "awsAppSyncGraphqlApiDetails": { # Asset information specific for AWS AppSync GraphQL APIs. # Output only. Asset information specific for AWS AppSync GraphQL APIs. + }, + "awsApplicationLoadBalancerDetails": { # Asset information specific for AWS Application Load Balancers. # Output only. Asset information specific for AWS Application Load Balancers. + }, + "awsAutoscalingGroupDetails": { # Asset information specific for AWS Autoscaling Group. # Output only. Asset information specific for AwsAutoscalingGroupDetails + }, + "awsBatchComputeEnvironmentDetails": { # Asset information specific for AWS Batch Compute Environments. # Output only. Asset information specific for AWS Batch Compute Environments. + }, "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions. }, "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables. }, + "awsEbsVolumeDetails": { # Asset information specific for AWS EBS Volumes. # Output only. Asset information specific for AWS EBS Volumes. + }, + "awsEcrRepositoryDetails": { # Asset information specific for AWS ECR Repository. # Output only. Asset information specific for AwsEcrRepositoryDetails + }, "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters. }, "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems. }, "awsEksClusterDetails": { # Asset information specific for AWS EKS clusters. # Output only. Asset information specific for AWS EKS clusters. }, + "awsElasticIpAddressDetails": { # Asset information specific for AWS Elastic IP Addresses. # Output only. Asset information specific for AWS Elastic IP Addresses. + }, + "awsElasticNetworkInterfaceDetails": { # Asset information specific for AWS Elastic Network Interfaces. # Output only. Asset information specific for AWS Elastic Network Interfaces. + }, "awsElbLoadBalancerDetails": { # Asset information specific for AWS Load Balancers. # Output only. Asset information specific for AWS Load Balancers. }, + "awsInternetGatewayDetails": { # Asset information specific for AWS Internet Gateways. # Output only. Asset information specific for AWS Internet Gateways. + }, "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions. }, "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails @@ -3498,6 +3584,8 @@

Method Details

"enabled": True or False, # Optional. Whether versioning is enabled. }, }, + "awsSnsTopicDetails": { # Asset information specific for AWS SNS Topics. # Output only. Asset information specific for AWS SNS Topics. + }, "awsVpcDetails": { # Asset information specific for AWS VPCs. # Output only. Asset information specific for AWS VPCs. }, "createTime": "A String", # Output only. The timestamp when the asset was created. @@ -4541,18 +4629,38 @@

Method Details

"attributes": { # Generic asset attributes. "a_key": "A String", }, + "awsApiGatewayRestApiDetails": { # Asset information specific for AWS API Gateway REST APIs. # Output only. Asset information specific for AWS API Gateway REST APIs. + }, + "awsAppSyncGraphqlApiDetails": { # Asset information specific for AWS AppSync GraphQL APIs. # Output only. Asset information specific for AWS AppSync GraphQL APIs. + }, + "awsApplicationLoadBalancerDetails": { # Asset information specific for AWS Application Load Balancers. # Output only. Asset information specific for AWS Application Load Balancers. + }, + "awsAutoscalingGroupDetails": { # Asset information specific for AWS Autoscaling Group. # Output only. Asset information specific for AwsAutoscalingGroupDetails + }, + "awsBatchComputeEnvironmentDetails": { # Asset information specific for AWS Batch Compute Environments. # Output only. Asset information specific for AWS Batch Compute Environments. + }, "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions. }, "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables. }, + "awsEbsVolumeDetails": { # Asset information specific for AWS EBS Volumes. # Output only. Asset information specific for AWS EBS Volumes. + }, + "awsEcrRepositoryDetails": { # Asset information specific for AWS ECR Repository. # Output only. Asset information specific for AwsEcrRepositoryDetails + }, "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters. }, "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems. }, "awsEksClusterDetails": { # Asset information specific for AWS EKS clusters. # Output only. Asset information specific for AWS EKS clusters. }, + "awsElasticIpAddressDetails": { # Asset information specific for AWS Elastic IP Addresses. # Output only. Asset information specific for AWS Elastic IP Addresses. + }, + "awsElasticNetworkInterfaceDetails": { # Asset information specific for AWS Elastic Network Interfaces. # Output only. Asset information specific for AWS Elastic Network Interfaces. + }, "awsElbLoadBalancerDetails": { # Asset information specific for AWS Load Balancers. # Output only. Asset information specific for AWS Load Balancers. }, + "awsInternetGatewayDetails": { # Asset information specific for AWS Internet Gateways. # Output only. Asset information specific for AWS Internet Gateways. + }, "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions. }, "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails @@ -4577,6 +4685,8 @@

Method Details

"enabled": True or False, # Optional. Whether versioning is enabled. }, }, + "awsSnsTopicDetails": { # Asset information specific for AWS SNS Topics. # Output only. Asset information specific for AWS SNS Topics. + }, "awsVpcDetails": { # Asset information specific for AWS VPCs. # Output only. Asset information specific for AWS VPCs. }, "createTime": "A String", # Output only. The timestamp when the asset was created. @@ -5600,18 +5710,38 @@

Method Details

"attributes": { # Generic asset attributes. "a_key": "A String", }, + "awsApiGatewayRestApiDetails": { # Asset information specific for AWS API Gateway REST APIs. # Output only. Asset information specific for AWS API Gateway REST APIs. + }, + "awsAppSyncGraphqlApiDetails": { # Asset information specific for AWS AppSync GraphQL APIs. # Output only. Asset information specific for AWS AppSync GraphQL APIs. + }, + "awsApplicationLoadBalancerDetails": { # Asset information specific for AWS Application Load Balancers. # Output only. Asset information specific for AWS Application Load Balancers. + }, + "awsAutoscalingGroupDetails": { # Asset information specific for AWS Autoscaling Group. # Output only. Asset information specific for AwsAutoscalingGroupDetails + }, + "awsBatchComputeEnvironmentDetails": { # Asset information specific for AWS Batch Compute Environments. # Output only. Asset information specific for AWS Batch Compute Environments. + }, "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions. }, "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables. }, + "awsEbsVolumeDetails": { # Asset information specific for AWS EBS Volumes. # Output only. Asset information specific for AWS EBS Volumes. + }, + "awsEcrRepositoryDetails": { # Asset information specific for AWS ECR Repository. # Output only. Asset information specific for AwsEcrRepositoryDetails + }, "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters. }, "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems. }, "awsEksClusterDetails": { # Asset information specific for AWS EKS clusters. # Output only. Asset information specific for AWS EKS clusters. }, + "awsElasticIpAddressDetails": { # Asset information specific for AWS Elastic IP Addresses. # Output only. Asset information specific for AWS Elastic IP Addresses. + }, + "awsElasticNetworkInterfaceDetails": { # Asset information specific for AWS Elastic Network Interfaces. # Output only. Asset information specific for AWS Elastic Network Interfaces. + }, "awsElbLoadBalancerDetails": { # Asset information specific for AWS Load Balancers. # Output only. Asset information specific for AWS Load Balancers. }, + "awsInternetGatewayDetails": { # Asset information specific for AWS Internet Gateways. # Output only. Asset information specific for AWS Internet Gateways. + }, "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions. }, "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails @@ -5636,6 +5766,8 @@

Method Details

"enabled": True or False, # Optional. Whether versioning is enabled. }, }, + "awsSnsTopicDetails": { # Asset information specific for AWS SNS Topics. # Output only. Asset information specific for AWS SNS Topics. + }, "awsVpcDetails": { # Asset information specific for AWS VPCs. # Output only. Asset information specific for AWS VPCs. }, "createTime": "A String", # Output only. The timestamp when the asset was created. @@ -6658,18 +6790,38 @@

Method Details

"attributes": { # Generic asset attributes. "a_key": "A String", }, + "awsApiGatewayRestApiDetails": { # Asset information specific for AWS API Gateway REST APIs. # Optional. Asset information specific for AWS API Gateway REST APIs. + }, + "awsAppSyncGraphqlApiDetails": { # Asset information specific for AWS AppSync GraphQL APIs. # Optional. Asset information specific for AWS AppSync GraphQL APIs. + }, + "awsApplicationLoadBalancerDetails": { # Asset information specific for AWS Application Load Balancers. # Optional. Asset information specific for AWS Application Load Balancers. + }, + "awsAutoscalingGroupDetails": { # Asset information specific for AWS Autoscaling Group. # Optional. Asset information specific for AwsAutoscalingGroupDetails + }, + "awsBatchComputeEnvironmentDetails": { # Asset information specific for AWS Batch Compute Environments. # Optional. Asset information specific for AWS Batch Compute Environments. + }, "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Asset information specific for AWS CloudFront distributions. }, "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Asset information specific for AWS DynamoDB tables. }, + "awsEbsVolumeDetails": { # Asset information specific for AWS EBS Volumes. # Optional. Asset information specific for AWS EBS Volumes. + }, + "awsEcrRepositoryDetails": { # Asset information specific for AWS ECR Repository. # Asset information specific for AwsEcrRepositoryDetails + }, "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Asset information specific for AWS ECS clusters. }, "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Asset information specific for AWS EFS file systems. }, "awsEksClusterDetails": { # Asset information specific for AWS EKS clusters. # Asset information specific for AWS EKS clusters. }, + "awsElasticIpAddressDetails": { # Asset information specific for AWS Elastic IP Addresses. # Optional. Asset information specific for AWS Elastic IP Addresses. + }, + "awsElasticNetworkInterfaceDetails": { # Asset information specific for AWS Elastic Network Interfaces. # Optional. Asset information specific for AWS Elastic Network Interfaces. + }, "awsElbLoadBalancerDetails": { # Asset information specific for AWS Load Balancers. # Asset information specific for AWS Load Balancers. }, + "awsInternetGatewayDetails": { # Asset information specific for AWS Internet Gateways. # Optional. Asset information specific for AWS Internet Gateways. + }, "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Asset information specific for AWS Lambda functions. }, "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Asset information specific for AwsNatGatewayDetails @@ -6694,6 +6846,8 @@

Method Details

"enabled": True or False, # Optional. Whether versioning is enabled. }, }, + "awsSnsTopicDetails": { # Asset information specific for AWS SNS Topics. # Optional. Asset information specific for AWS SNS Topics. + }, "awsVpcDetails": { # Asset information specific for AWS VPCs. # Asset information specific for AWS VPCs. }, "collectionType": "A String", # Optional. Frame collection type, if not specified the collection type will be based on the source type of the source the frame was reported on. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html index 1e14090115..c6e5e526cc 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html @@ -193,6 +193,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, @@ -421,6 +426,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, @@ -589,6 +599,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, @@ -765,6 +780,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html index 038f848cd6..449a937f6e 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html @@ -145,6 +145,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -234,6 +238,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -325,6 +333,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -451,6 +463,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, @@ -646,6 +663,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, @@ -772,6 +794,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -960,6 +986,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -1049,6 +1079,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -1140,6 +1174,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -1266,6 +1304,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, @@ -1461,6 +1504,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, @@ -1587,6 +1635,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -1716,6 +1768,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -1805,6 +1861,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -1896,6 +1956,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. @@ -2022,6 +2086,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, @@ -2217,6 +2286,11 @@

Method Details

}, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. }, + "estimatedUsage": { # Estimated usage data. # Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data. + "estimatedCpuPercentage": 3.14, # Optional. Estimated CPU utilization percentage. Must be in the range [1, 100]. + "estimatedDiskPercentage": 3.14, # Optional. Estimated disk utilization percentage. Must be in the range [1, 100]. + "estimatedMemoryPercentage": 3.14, # Optional. Estimated memory utilization percentage. Must be in the range [1, 100]. + }, "networkCostParameters": { # Parameters that affect network cost estimations. # Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. "estimatedEgressTrafficPercentage": 42, # Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. }, @@ -2343,6 +2417,10 @@

Method Details

}, ], }, + "estimatedUsageStats": { # Estimated usage stats for the assets in this collection. # Output only. Estimated usage stats for the assets in this collection. + "totalAssetsUsingEstimatedUsage": "A String", # Output only. The number of assets that are using at least one estimated usage metric for rightsizing. + "totalVirtualMachinesUsingEstimatedUsage": "A String", # Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing. + }, "memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes. "buckets": [ # Buckets in the histogram. There will be `n+1` buckets matching `n` lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity. { # A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html index e748d4e74e..3eee6bdd09 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html @@ -118,18 +118,38 @@

Method Details

"attributes": { # Generic asset attributes. "a_key": "A String", }, + "awsApiGatewayRestApiDetails": { # Asset information specific for AWS API Gateway REST APIs. # Optional. Asset information specific for AWS API Gateway REST APIs. + }, + "awsAppSyncGraphqlApiDetails": { # Asset information specific for AWS AppSync GraphQL APIs. # Optional. Asset information specific for AWS AppSync GraphQL APIs. + }, + "awsApplicationLoadBalancerDetails": { # Asset information specific for AWS Application Load Balancers. # Optional. Asset information specific for AWS Application Load Balancers. + }, + "awsAutoscalingGroupDetails": { # Asset information specific for AWS Autoscaling Group. # Optional. Asset information specific for AwsAutoscalingGroupDetails + }, + "awsBatchComputeEnvironmentDetails": { # Asset information specific for AWS Batch Compute Environments. # Optional. Asset information specific for AWS Batch Compute Environments. + }, "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Asset information specific for AWS CloudFront distributions. }, "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Asset information specific for AWS DynamoDB tables. }, + "awsEbsVolumeDetails": { # Asset information specific for AWS EBS Volumes. # Optional. Asset information specific for AWS EBS Volumes. + }, + "awsEcrRepositoryDetails": { # Asset information specific for AWS ECR Repository. # Asset information specific for AwsEcrRepositoryDetails + }, "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Asset information specific for AWS ECS clusters. }, "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Asset information specific for AWS EFS file systems. }, "awsEksClusterDetails": { # Asset information specific for AWS EKS clusters. # Asset information specific for AWS EKS clusters. }, + "awsElasticIpAddressDetails": { # Asset information specific for AWS Elastic IP Addresses. # Optional. Asset information specific for AWS Elastic IP Addresses. + }, + "awsElasticNetworkInterfaceDetails": { # Asset information specific for AWS Elastic Network Interfaces. # Optional. Asset information specific for AWS Elastic Network Interfaces. + }, "awsElbLoadBalancerDetails": { # Asset information specific for AWS Load Balancers. # Asset information specific for AWS Load Balancers. }, + "awsInternetGatewayDetails": { # Asset information specific for AWS Internet Gateways. # Optional. Asset information specific for AWS Internet Gateways. + }, "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Asset information specific for AWS Lambda functions. }, "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Asset information specific for AwsNatGatewayDetails @@ -154,6 +174,8 @@

Method Details

"enabled": True or False, # Optional. Whether versioning is enabled. }, }, + "awsSnsTopicDetails": { # Asset information specific for AWS SNS Topics. # Optional. Asset information specific for AWS SNS Topics. + }, "awsVpcDetails": { # Asset information specific for AWS VPCs. # Asset information specific for AWS VPCs. }, "collectionType": "A String", # Optional. Frame collection type, if not specified the collection type will be based on the source type of the source the frame was reported on. @@ -1049,18 +1071,38 @@

Method Details

"attributes": { # Generic asset attributes. "a_key": "A String", }, + "awsApiGatewayRestApiDetails": { # Asset information specific for AWS API Gateway REST APIs. # Optional. Asset information specific for AWS API Gateway REST APIs. + }, + "awsAppSyncGraphqlApiDetails": { # Asset information specific for AWS AppSync GraphQL APIs. # Optional. Asset information specific for AWS AppSync GraphQL APIs. + }, + "awsApplicationLoadBalancerDetails": { # Asset information specific for AWS Application Load Balancers. # Optional. Asset information specific for AWS Application Load Balancers. + }, + "awsAutoscalingGroupDetails": { # Asset information specific for AWS Autoscaling Group. # Optional. Asset information specific for AwsAutoscalingGroupDetails + }, + "awsBatchComputeEnvironmentDetails": { # Asset information specific for AWS Batch Compute Environments. # Optional. Asset information specific for AWS Batch Compute Environments. + }, "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Asset information specific for AWS CloudFront distributions. }, "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Asset information specific for AWS DynamoDB tables. }, + "awsEbsVolumeDetails": { # Asset information specific for AWS EBS Volumes. # Optional. Asset information specific for AWS EBS Volumes. + }, + "awsEcrRepositoryDetails": { # Asset information specific for AWS ECR Repository. # Asset information specific for AwsEcrRepositoryDetails + }, "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Asset information specific for AWS ECS clusters. }, "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Asset information specific for AWS EFS file systems. }, "awsEksClusterDetails": { # Asset information specific for AWS EKS clusters. # Asset information specific for AWS EKS clusters. }, + "awsElasticIpAddressDetails": { # Asset information specific for AWS Elastic IP Addresses. # Optional. Asset information specific for AWS Elastic IP Addresses. + }, + "awsElasticNetworkInterfaceDetails": { # Asset information specific for AWS Elastic Network Interfaces. # Optional. Asset information specific for AWS Elastic Network Interfaces. + }, "awsElbLoadBalancerDetails": { # Asset information specific for AWS Load Balancers. # Asset information specific for AWS Load Balancers. }, + "awsInternetGatewayDetails": { # Asset information specific for AWS Internet Gateways. # Optional. Asset information specific for AWS Internet Gateways. + }, "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Asset information specific for AWS Lambda functions. }, "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Asset information specific for AwsNatGatewayDetails @@ -1085,6 +1127,8 @@

Method Details

"enabled": True or False, # Optional. Whether versioning is enabled. }, }, + "awsSnsTopicDetails": { # Asset information specific for AWS SNS Topics. # Optional. Asset information specific for AWS SNS Topics. + }, "awsVpcDetails": { # Asset information specific for AWS VPCs. # Asset information specific for AWS VPCs. }, "collectionType": "A String", # Optional. Frame collection type, if not specified the collection type will be based on the source type of the source the frame was reported on. diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index f84f98668c..b20da55409 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2722,7 +2722,7 @@ } } }, -"revision": "20260126", +"revision": "20260310", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2953,6 +2953,31 @@ "description": "Generic asset attributes.", "type": "object" }, +"awsApiGatewayRestApiDetails": { +"$ref": "AwsApiGatewayRestApiDetails", +"description": "Output only. Asset information specific for AWS API Gateway REST APIs.", +"readOnly": true +}, +"awsAppSyncGraphqlApiDetails": { +"$ref": "AwsAppSyncGraphqlApiDetails", +"description": "Output only. Asset information specific for AWS AppSync GraphQL APIs.", +"readOnly": true +}, +"awsApplicationLoadBalancerDetails": { +"$ref": "AwsApplicationLoadBalancerDetails", +"description": "Output only. Asset information specific for AWS Application Load Balancers.", +"readOnly": true +}, +"awsAutoscalingGroupDetails": { +"$ref": "AwsAutoscalingGroupDetails", +"description": "Output only. Asset information specific for AwsAutoscalingGroupDetails", +"readOnly": true +}, +"awsBatchComputeEnvironmentDetails": { +"$ref": "AwsBatchComputeEnvironmentDetails", +"description": "Output only. Asset information specific for AWS Batch Compute Environments.", +"readOnly": true +}, "awsCloudFrontDistributionDetails": { "$ref": "AwsCloudFrontDistributionDetails", "description": "Output only. Asset information specific for AWS CloudFront distributions.", @@ -2963,6 +2988,16 @@ "description": "Output only. Asset information specific for AWS DynamoDB tables.", "readOnly": true }, +"awsEbsVolumeDetails": { +"$ref": "AwsEbsVolumeDetails", +"description": "Output only. Asset information specific for AWS EBS Volumes.", +"readOnly": true +}, +"awsEcrRepositoryDetails": { +"$ref": "AwsEcrRepositoryDetails", +"description": "Output only. Asset information specific for AwsEcrRepositoryDetails", +"readOnly": true +}, "awsEcsClusterDetails": { "$ref": "AwsEcsClusterDetails", "description": "Output only. Asset information specific for AWS ECS clusters.", @@ -2978,11 +3013,26 @@ "description": "Output only. Asset information specific for AWS EKS clusters.", "readOnly": true }, +"awsElasticIpAddressDetails": { +"$ref": "AwsElasticIpAddressDetails", +"description": "Output only. Asset information specific for AWS Elastic IP Addresses.", +"readOnly": true +}, +"awsElasticNetworkInterfaceDetails": { +"$ref": "AwsElasticNetworkInterfaceDetails", +"description": "Output only. Asset information specific for AWS Elastic Network Interfaces.", +"readOnly": true +}, "awsElbLoadBalancerDetails": { "$ref": "AwsElbLoadBalancerDetails", "description": "Output only. Asset information specific for AWS Load Balancers.", "readOnly": true }, +"awsInternetGatewayDetails": { +"$ref": "AwsInternetGatewayDetails", +"description": "Output only. Asset information specific for AWS Internet Gateways.", +"readOnly": true +}, "awsLambdaFunctionDetails": { "$ref": "AwsLambdaFunctionDetails", "description": "Output only. Asset information specific for AWS Lambda functions.", @@ -3008,6 +3058,11 @@ "description": "Output only. Asset information specific for AWS S3 buckets.", "readOnly": true }, +"awsSnsTopicDetails": { +"$ref": "AwsSnsTopicDetails", +"description": "Output only. Asset information specific for AWS SNS Topics.", +"readOnly": true +}, "awsVpcDetails": { "$ref": "AwsVpcDetails", "description": "Output only. Asset information specific for AWS VPCs.", @@ -3120,6 +3175,26 @@ "description": "Generic asset attributes.", "type": "object" }, +"awsApiGatewayRestApiDetails": { +"$ref": "AwsApiGatewayRestApiDetails", +"description": "Optional. Asset information specific for AWS API Gateway REST APIs." +}, +"awsAppSyncGraphqlApiDetails": { +"$ref": "AwsAppSyncGraphqlApiDetails", +"description": "Optional. Asset information specific for AWS AppSync GraphQL APIs." +}, +"awsApplicationLoadBalancerDetails": { +"$ref": "AwsApplicationLoadBalancerDetails", +"description": "Optional. Asset information specific for AWS Application Load Balancers." +}, +"awsAutoscalingGroupDetails": { +"$ref": "AwsAutoscalingGroupDetails", +"description": "Optional. Asset information specific for AwsAutoscalingGroupDetails" +}, +"awsBatchComputeEnvironmentDetails": { +"$ref": "AwsBatchComputeEnvironmentDetails", +"description": "Optional. Asset information specific for AWS Batch Compute Environments." +}, "awsCloudFrontDistributionDetails": { "$ref": "AwsCloudFrontDistributionDetails", "description": "Asset information specific for AWS CloudFront distributions." @@ -3128,6 +3203,14 @@ "$ref": "AwsDynamoDBTableDetails", "description": "Asset information specific for AWS DynamoDB tables." }, +"awsEbsVolumeDetails": { +"$ref": "AwsEbsVolumeDetails", +"description": "Optional. Asset information specific for AWS EBS Volumes." +}, +"awsEcrRepositoryDetails": { +"$ref": "AwsEcrRepositoryDetails", +"description": "Asset information specific for AwsEcrRepositoryDetails" +}, "awsEcsClusterDetails": { "$ref": "AwsEcsClusterDetails", "description": "Asset information specific for AWS ECS clusters." @@ -3140,10 +3223,22 @@ "$ref": "AwsEksClusterDetails", "description": "Asset information specific for AWS EKS clusters." }, +"awsElasticIpAddressDetails": { +"$ref": "AwsElasticIpAddressDetails", +"description": "Optional. Asset information specific for AWS Elastic IP Addresses." +}, +"awsElasticNetworkInterfaceDetails": { +"$ref": "AwsElasticNetworkInterfaceDetails", +"description": "Optional. Asset information specific for AWS Elastic Network Interfaces." +}, "awsElbLoadBalancerDetails": { "$ref": "AwsElbLoadBalancerDetails", "description": "Asset information specific for AWS Load Balancers." }, +"awsInternetGatewayDetails": { +"$ref": "AwsInternetGatewayDetails", +"description": "Optional. Asset information specific for AWS Internet Gateways." +}, "awsLambdaFunctionDetails": { "$ref": "AwsLambdaFunctionDetails", "description": "Asset information specific for AWS Lambda functions." @@ -3164,6 +3259,10 @@ "$ref": "AwsS3BucketDetails", "description": "Asset information specific for AWS S3 buckets." }, +"awsSnsTopicDetails": { +"$ref": "AwsSnsTopicDetails", +"description": "Optional. Asset information specific for AWS SNS Topics." +}, "awsVpcDetails": { "$ref": "AwsVpcDetails", "description": "Asset information specific for AWS VPCs." @@ -3431,6 +3530,36 @@ }, "type": "object" }, +"AwsApiGatewayRestApiDetails": { +"description": "Asset information specific for AWS API Gateway REST APIs.", +"id": "AwsApiGatewayRestApiDetails", +"properties": {}, +"type": "object" +}, +"AwsAppSyncGraphqlApiDetails": { +"description": "Asset information specific for AWS AppSync GraphQL APIs.", +"id": "AwsAppSyncGraphqlApiDetails", +"properties": {}, +"type": "object" +}, +"AwsApplicationLoadBalancerDetails": { +"description": "Asset information specific for AWS Application Load Balancers.", +"id": "AwsApplicationLoadBalancerDetails", +"properties": {}, +"type": "object" +}, +"AwsAutoscalingGroupDetails": { +"description": "Asset information specific for AWS Autoscaling Group.", +"id": "AwsAutoscalingGroupDetails", +"properties": {}, +"type": "object" +}, +"AwsBatchComputeEnvironmentDetails": { +"description": "Asset information specific for AWS Batch Compute Environments.", +"id": "AwsBatchComputeEnvironmentDetails", +"properties": {}, +"type": "object" +}, "AwsCloudFrontDistributionDetails": { "description": "Details of an AWS CloudFront distribution.", "id": "AwsCloudFrontDistributionDetails", @@ -3443,6 +3572,12 @@ "properties": {}, "type": "object" }, +"AwsEbsVolumeDetails": { +"description": "Asset information specific for AWS EBS Volumes.", +"id": "AwsEbsVolumeDetails", +"properties": {}, +"type": "object" +}, "AwsEc2PlatformDetails": { "description": "AWS EC2 specific details.", "id": "AwsEc2PlatformDetails", @@ -3472,6 +3607,12 @@ }, "type": "object" }, +"AwsEcrRepositoryDetails": { +"description": "Asset information specific for AWS ECR Repository.", +"id": "AwsEcrRepositoryDetails", +"properties": {}, +"type": "object" +}, "AwsEcsClusterDetails": { "description": "Details of an AWS ECS cluster.", "id": "AwsEcsClusterDetails", @@ -3490,12 +3631,30 @@ "properties": {}, "type": "object" }, +"AwsElasticIpAddressDetails": { +"description": "Asset information specific for AWS Elastic IP Addresses.", +"id": "AwsElasticIpAddressDetails", +"properties": {}, +"type": "object" +}, +"AwsElasticNetworkInterfaceDetails": { +"description": "Asset information specific for AWS Elastic Network Interfaces.", +"id": "AwsElasticNetworkInterfaceDetails", +"properties": {}, +"type": "object" +}, "AwsElbLoadBalancerDetails": { "description": "Asset information specific for AWS Load Balancers.", "id": "AwsElbLoadBalancerDetails", "properties": {}, "type": "object" }, +"AwsInternetGatewayDetails": { +"description": "Asset information specific for AWS Internet Gateways.", +"id": "AwsInternetGatewayDetails", +"properties": {}, +"type": "object" +}, "AwsLambdaFunctionDetails": { "description": "Asset information specific for AWS Lambda functions.", "id": "AwsLambdaFunctionDetails", @@ -3622,6 +3781,12 @@ }, "type": "object" }, +"AwsSnsTopicDetails": { +"description": "Asset information specific for AWS SNS Topics.", +"id": "AwsSnsTopicDetails", +"properties": {}, +"type": "object" +}, "AwsVpcDetails": { "description": "Asset information specific for AWS VPCs.", "id": "AwsVpcDetails", @@ -5278,6 +5443,28 @@ }, "type": "object" }, +"EstimatedUsage": { +"description": "Estimated usage data.", +"id": "EstimatedUsage", +"properties": { +"estimatedCpuPercentage": { +"description": "Optional. Estimated CPU utilization percentage. Must be in the range [1, 100].", +"format": "float", +"type": "number" +}, +"estimatedDiskPercentage": { +"description": "Optional. Estimated disk utilization percentage. Must be in the range [1, 100].", +"format": "float", +"type": "number" +}, +"estimatedMemoryPercentage": { +"description": "Optional. Estimated memory utilization percentage. Must be in the range [1, 100].", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "ExecutionReport": { "description": "A resource that reports result of the import job execution.", "id": "ExecutionReport", @@ -8103,6 +8290,11 @@ false "description": "Output only. Count of assets grouped by database type. Keys here are taken from DatabaseType enum. Only present for databases.", "readOnly": true }, +"estimatedUsageStats": { +"$ref": "ReportSummaryAssetAggregateStatsEstimatedUsageStats", +"description": "Output only. Estimated usage stats for the assets in this collection.", +"readOnly": true +}, "memoryBytesHistogram": { "$ref": "ReportSummaryHistogramChartData", "description": "Histogram showing a distribution of memory sizes." @@ -8161,6 +8353,25 @@ false }, "type": "object" }, +"ReportSummaryAssetAggregateStatsEstimatedUsageStats": { +"description": "Estimated usage stats for the assets in this collection.", +"id": "ReportSummaryAssetAggregateStatsEstimatedUsageStats", +"properties": { +"totalAssetsUsingEstimatedUsage": { +"description": "Output only. The number of assets that are using at least one estimated usage metric for rightsizing.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"totalVirtualMachinesUsingEstimatedUsage": { +"description": "Output only. The number of virtual machines in this finding that are using at least one estimated usage metric for rightsizing.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ReportSummaryChartData": { "description": "Describes a collection of data points rendered as a Chart.", "id": "ReportSummaryChartData", @@ -9590,6 +9801,10 @@ false "$ref": "ComputeEnginePreferences", "description": "Optional. Compute Engine preferences concern insights and recommendations for Compute Engine target." }, +"estimatedUsage": { +"$ref": "EstimatedUsage", +"description": "Optional. Estimated usage data for missing usage data. If performance data is available, it overrides this field. If not set, default values will be used for the usage data." +}, "networkCostParameters": { "$ref": "VirtualMachinePreferencesNetworkCostParameters", "description": "Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters." From 8371670da6d9d37f44120ba7c7f8e8b7a7146036 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 25/31] feat(networkconnectivity): update the api #### networkconnectivity:v1 The following keys were added: - schemas.LinkedInterconnectAttachments.properties.excludeExportRanges (Total Keys: 2) - schemas.LinkedInterconnectAttachments.properties.excludeImportRanges (Total Keys: 2) - schemas.LinkedInterconnectAttachments.properties.includeExportRanges (Total Keys: 2) - schemas.LinkedRouterApplianceInstances.properties.excludeExportRanges (Total Keys: 2) - schemas.LinkedRouterApplianceInstances.properties.excludeImportRanges (Total Keys: 2) - schemas.LinkedRouterApplianceInstances.properties.includeExportRanges (Total Keys: 2) - schemas.LinkedVpnTunnels.properties.excludeExportRanges (Total Keys: 2) - schemas.LinkedVpnTunnels.properties.excludeImportRanges (Total Keys: 2) - schemas.LinkedVpnTunnels.properties.includeExportRanges (Total Keys: 2) --- ...ty_v1.projects.locations.global_.hubs.html | 27 +++++ ...ectivity_v1.projects.locations.spokes.html | 108 ++++++++++++++++++ .../documents/networkconnectivity.v1.json | 71 +++++++++++- 3 files changed, 203 insertions(+), 3 deletions(-) diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html index feb0c4453c..4d1e40dee6 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html @@ -569,6 +569,15 @@

Method Details

"a_key": "A String", }, "linkedInterconnectAttachments": { # A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. # Optional. VLAN attachments that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -597,6 +606,15 @@

Method Details

"serviceConsumerVpcSpoke": "A String", # Output only. The Service Consumer Network spoke. }, "linkedRouterApplianceInstances": { # A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. # Optional. Router appliance instances that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -628,6 +646,15 @@

Method Details

"uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # Optional. VPN tunnels that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html index 91692319df..0ec28f0a52 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html @@ -132,6 +132,15 @@

Method Details

"a_key": "A String", }, "linkedInterconnectAttachments": { # A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. # Optional. VLAN attachments that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -160,6 +169,15 @@

Method Details

"serviceConsumerVpcSpoke": "A String", # Output only. The Service Consumer Network spoke. }, "linkedRouterApplianceInstances": { # A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. # Optional. Router appliance instances that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -191,6 +209,15 @@

Method Details

"uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # Optional. VPN tunnels that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -308,6 +335,15 @@

Method Details

"a_key": "A String", }, "linkedInterconnectAttachments": { # A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. # Optional. VLAN attachments that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -336,6 +372,15 @@

Method Details

"serviceConsumerVpcSpoke": "A String", # Output only. The Service Consumer Network spoke. }, "linkedRouterApplianceInstances": { # A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. # Optional. Router appliance instances that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -367,6 +412,15 @@

Method Details

"uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # Optional. VPN tunnels that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -473,6 +527,15 @@

Method Details

"a_key": "A String", }, "linkedInterconnectAttachments": { # A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. # Optional. VLAN attachments that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -501,6 +564,15 @@

Method Details

"serviceConsumerVpcSpoke": "A String", # Output only. The Service Consumer Network spoke. }, "linkedRouterApplianceInstances": { # A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. # Optional. Router appliance instances that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -532,6 +604,15 @@

Method Details

"uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # Optional. VPN tunnels that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -597,6 +678,15 @@

Method Details

"a_key": "A String", }, "linkedInterconnectAttachments": { # A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. # Optional. VLAN attachments that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -625,6 +715,15 @@

Method Details

"serviceConsumerVpcSpoke": "A String", # Output only. The Service Consumer Network spoke. }, "linkedRouterApplianceInstances": { # A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. # Optional. Router appliance instances that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], @@ -656,6 +755,15 @@

Method Details

"uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # Optional. VPN tunnels that are associated with the spoke. + "excludeExportRanges": [ # Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub. + "A String", + ], + "excludeImportRanges": [ # Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub. + "A String", + ], + "includeExportRanges": [ # Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub. + "A String", + ], "includeImportRanges": [ # Optional. Hub routes fully encompassed by include import ranges are included during import from hub. "A String", ], diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index 1a0e6deb18..0bb1d03548 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -3718,7 +3718,7 @@ } } }, -"revision": "20260129", +"revision": "20260309", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -5018,6 +5018,27 @@ "description": "A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes.", "id": "LinkedInterconnectAttachments", "properties": { +"excludeExportRanges": { +"description": "Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub.", +"items": { +"type": "string" +}, +"type": "array" +}, +"excludeImportRanges": { +"description": "Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includeExportRanges": { +"description": "Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub.", +"items": { +"type": "string" +}, +"type": "array" +}, "includeImportRanges": { "description": "Optional. Hub routes fully encompassed by include import ranges are included during import from hub.", "items": { @@ -5102,6 +5123,27 @@ "description": "A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke.", "id": "LinkedRouterApplianceInstances", "properties": { +"excludeExportRanges": { +"description": "Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub.", +"items": { +"type": "string" +}, +"type": "array" +}, +"excludeImportRanges": { +"description": "Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includeExportRanges": { +"description": "Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub.", +"items": { +"type": "string" +}, +"type": "array" +}, "includeImportRanges": { "description": "Optional. Hub routes fully encompassed by include import ranges are included during import from hub.", "items": { @@ -5181,6 +5223,27 @@ "description": "A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes.", "id": "LinkedVpnTunnels", "properties": { +"excludeExportRanges": { +"description": "Optional. Dynamic routes overlapped/encompassed by exclude export ranges are excluded during export to hub.", +"items": { +"type": "string" +}, +"type": "array" +}, +"excludeImportRanges": { +"description": "Optional. Hub routes overlapped/encompassed by exclude import ranges are excluded during import from hub.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includeExportRanges": { +"description": "Optional. Dynamic routes fully encompassed by include export ranges are included during export to hub.", +"items": { +"type": "string" +}, +"type": "array" +}, "includeImportRanges": { "description": "Optional. Hub routes fully encompassed by include import ranges are included during import from hub.", "items": { @@ -5688,13 +5751,15 @@ "LOCATION_FEATURE_UNSPECIFIED", "SITE_TO_CLOUD_SPOKES", "SITE_TO_SITE_SPOKES", -"GATEWAY_SPOKES" +"GATEWAY_SPOKES", +"TRANSPORTS" ], "enumDescriptions": [ "No publicly supported feature in this location", "Site-to-cloud spokes are supported in this location", "Site-to-site spokes are supported in this location", -"Gateway spokes are supported in this location." +"Gateway spokes are supported in this location.", +"Supports transports in this location." ], "type": "string" }, From 3317e693e0c56dd9c155ba8ceef5275c00abf8e9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 26/31] feat(redis): update the api #### redis:v1 The following keys were added: - schemas.Cluster.properties.aclPolicy.type (Total Keys: 1) - schemas.DatabaseResourceSignalData.properties.backupRun (Total Keys: 2) - schemas.DatabaseResourceSignalData.properties.location.type (Total Keys: 1) - schemas.DatabaseResourceSignalData.properties.signalBoolValue.deprecated (Total Keys: 1) - schemas.DatabaseResourceSignalData.properties.signalMetadataList (Total Keys: 2) - schemas.SignalMetadata (Total Keys: 4) #### redis:v1beta1 The following keys were added: - schemas.Cluster.properties.aclPolicy.type (Total Keys: 1) - schemas.DatabaseResourceSignalData.properties.backupRun (Total Keys: 2) - schemas.DatabaseResourceSignalData.properties.location.type (Total Keys: 1) - schemas.DatabaseResourceSignalData.properties.signalBoolValue.deprecated (Total Keys: 1) - schemas.DatabaseResourceSignalData.properties.signalMetadataList (Total Keys: 2) - schemas.SignalMetadata (Total Keys: 4) --- .../redis_v1.projects.locations.clusters.html | 4 + ...redis_v1.projects.locations.instances.html | 8 +- ...s_v1beta1.projects.locations.clusters.html | 4 + ..._v1beta1.projects.locations.instances.html | 8 +- .../discovery_cache/documents/redis.v1.json | 87 ++++++++++++++++--- .../documents/redis.v1beta1.json | 87 ++++++++++++++++--- 6 files changed, 166 insertions(+), 32 deletions(-) diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html index e5a4405ebe..886b898944 100644 --- a/docs/dyn/redis_v1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1.projects.locations.clusters.html @@ -163,6 +163,7 @@

Method Details

The object takes the form of: { # A cluster instance. + "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -437,6 +438,7 @@

Method Details

An object of the form: { # A cluster instance. + "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -677,6 +679,7 @@

Method Details

{ # Response for ListClusters. "clusters": [ # A list of Redis clusters in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/clusters/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListClusters". { # A cluster instance. + "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -900,6 +903,7 @@

Method Details

The object takes the form of: { # A cluster instance. + "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. diff --git a/docs/dyn/redis_v1.projects.locations.instances.html b/docs/dyn/redis_v1.projects.locations.instances.html index bdd220e179..74238cf8d5 100644 --- a/docs/dyn/redis_v1.projects.locations.instances.html +++ b/docs/dyn/redis_v1.projects.locations.instances.html @@ -188,7 +188,7 @@

Method Details

"readEndpoint": "A String", # Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. "readEndpointPort": 42, # Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. "readReplicasMode": "A String", # Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. - "redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries + "redisConfigs": { # Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries "a_key": "A String", }, "redisVersion": "A String", # Optional. The version of Redis software. If not provided, the default version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility @@ -445,7 +445,7 @@

Method Details

"readEndpoint": "A String", # Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. "readEndpointPort": 42, # Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. "readReplicasMode": "A String", # Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. - "redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries + "redisConfigs": { # Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries "a_key": "A String", }, "redisVersion": "A String", # Optional. The version of Redis software. If not provided, the default version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility @@ -619,7 +619,7 @@

Method Details

"readEndpoint": "A String", # Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. "readEndpointPort": 42, # Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. "readReplicasMode": "A String", # Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. - "redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries + "redisConfigs": { # Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries "a_key": "A String", }, "redisVersion": "A String", # Optional. The version of Redis software. If not provided, the default version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility @@ -739,7 +739,7 @@

Method Details

"readEndpoint": "A String", # Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. "readEndpointPort": 42, # Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. "readReplicasMode": "A String", # Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. - "redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries + "redisConfigs": { # Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries "a_key": "A String", }, "redisVersion": "A String", # Optional. The version of Redis software. If not provided, the default version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index 3074663328..469a740f4d 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -163,6 +163,7 @@

Method Details

The object takes the form of: { # A cluster instance. + "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -437,6 +438,7 @@

Method Details

An object of the form: { # A cluster instance. + "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -677,6 +679,7 @@

Method Details

{ # Response for ListClusters. "clusters": [ # A list of Redis clusters in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/clusters/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListClusters". { # A cluster instance. + "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. @@ -900,6 +903,7 @@

Method Details

The object takes the form of: { # A cluster instance. + "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. "allowFewerZonesDeployment": True or False, # Optional. Immutable. Deprecated, do not use. "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. diff --git a/docs/dyn/redis_v1beta1.projects.locations.instances.html b/docs/dyn/redis_v1beta1.projects.locations.instances.html index e3bd5f644d..336caca19c 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.instances.html +++ b/docs/dyn/redis_v1beta1.projects.locations.instances.html @@ -188,7 +188,7 @@

Method Details

"readEndpoint": "A String", # Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. "readEndpointPort": 42, # Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. "readReplicasMode": "A String", # Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. - "redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries + "redisConfigs": { # Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries "a_key": "A String", }, "redisVersion": "A String", # Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility @@ -445,7 +445,7 @@

Method Details

"readEndpoint": "A String", # Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. "readEndpointPort": 42, # Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. "readReplicasMode": "A String", # Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. - "redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries + "redisConfigs": { # Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries "a_key": "A String", }, "redisVersion": "A String", # Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility @@ -619,7 +619,7 @@

Method Details

"readEndpoint": "A String", # Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. "readEndpointPort": 42, # Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. "readReplicasMode": "A String", # Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. - "redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries + "redisConfigs": { # Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries "a_key": "A String", }, "redisVersion": "A String", # Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility @@ -739,7 +739,7 @@

Method Details

"readEndpoint": "A String", # Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. "readEndpointPort": 42, # Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. "readReplicasMode": "A String", # Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. - "redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries + "redisConfigs": { # Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries "a_key": "A String", }, "redisVersion": "A String", # Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 2fe3381fa0..79b37880eb 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -1103,7 +1103,7 @@ } } }, -"revision": "20260210", +"revision": "20260309", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1548,6 +1548,10 @@ "description": "A cluster instance.", "id": "Cluster", "properties": { +"aclPolicy": { +"description": "Optional. The ACL policy to be applied to the cluster.", +"type": "string" +}, "allowFewerZonesDeployment": { "deprecated": true, "description": "Optional. Immutable. Deprecated, do not use.", @@ -2001,7 +2005,10 @@ "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.", @@ -2011,7 +2018,10 @@ "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" } @@ -2382,7 +2392,8 @@ "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, @@ -2490,6 +2501,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2598,7 +2610,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" }, @@ -2779,6 +2792,9 @@ false "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", +"SUB_RESOURCE_TYPE_READ_POOL", +"SUB_RESOURCE_TYPE_RESERVATION", +"SUB_RESOURCE_TYPE_DATASET", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -2792,6 +2808,9 @@ false, false, false, false, +false, +false, +false, false ], "enumDescriptions": [ @@ -2805,6 +2824,9 @@ 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.", +"Represents a reservation resource.", +"Represents a dataset resource.", "For rest of the other categories." ], "type": "string" @@ -3055,7 +3077,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, @@ -3163,6 +3186,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3271,7 +3295,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" } @@ -3279,9 +3304,14 @@ false "type": "object" }, "DatabaseResourceSignalData": { -"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: 10", "id": "DatabaseResourceSignalData", "properties": { +"backupRun": { +"$ref": "BackupRun", +"deprecated": true, +"description": "Deprecated: Use signal_metadata_list instead." +}, "fullResourceName": { "description": "Required. Full Resource name of the source resource.", "type": "string" @@ -3291,14 +3321,26 @@ false "format": "google-datetime", "type": "string" }, +"location": { +"description": "Resource location.", +"type": "string" +}, "resourceId": { "$ref": "DatabaseResourceId", "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": "SignalMetadata" +}, +"type": "array" +}, "signalState": { "description": "Required. Output only. Signal state of the signal", "enum": [ @@ -3326,7 +3368,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.", @@ -3336,7 +3381,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" } @@ -3827,7 +3875,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries", +"description": "Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries", "type": "object" }, "redisVersion": { @@ -5240,6 +5288,21 @@ false }, "type": "object" }, +"SignalMetadata": { +"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": "SignalMetadata", +"properties": { +"backupRun": { +"$ref": "BackupRun", +"description": "Signal data for backup runs." +}, +"signalBoolValue": { +"description": "Signal data for boolean signals.", +"type": "boolean" +} +}, +"type": "object" +}, "StateInfo": { "description": "Represents additional information about the state of the cluster.", "id": "StateInfo", diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index dad6951a9d..af454e22a7 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -1103,7 +1103,7 @@ } } }, -"revision": "20260210", +"revision": "20260309", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1548,6 +1548,10 @@ "description": "A cluster instance.", "id": "Cluster", "properties": { +"aclPolicy": { +"description": "Optional. The ACL policy to be applied to the cluster.", +"type": "string" +}, "allowFewerZonesDeployment": { "deprecated": true, "description": "Optional. Immutable. Deprecated, do not use.", @@ -2001,7 +2005,10 @@ "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.", @@ -2011,7 +2018,10 @@ "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" } @@ -2382,7 +2392,8 @@ "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, @@ -2490,6 +2501,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2598,7 +2610,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" }, @@ -2779,6 +2792,9 @@ false "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", +"SUB_RESOURCE_TYPE_READ_POOL", +"SUB_RESOURCE_TYPE_RESERVATION", +"SUB_RESOURCE_TYPE_DATASET", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -2792,6 +2808,9 @@ false, false, false, false, +false, +false, +false, false ], "enumDescriptions": [ @@ -2805,6 +2824,9 @@ 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.", +"Represents a reservation resource.", +"Represents a dataset resource.", "For rest of the other categories." ], "type": "string" @@ -3055,7 +3077,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, @@ -3163,6 +3186,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3271,7 +3295,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" } @@ -3279,9 +3304,14 @@ false "type": "object" }, "DatabaseResourceSignalData": { -"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: 10", "id": "DatabaseResourceSignalData", "properties": { +"backupRun": { +"$ref": "BackupRun", +"deprecated": true, +"description": "Deprecated: Use signal_metadata_list instead." +}, "fullResourceName": { "description": "Required. Full Resource name of the source resource.", "type": "string" @@ -3291,14 +3321,26 @@ false "format": "google-datetime", "type": "string" }, +"location": { +"description": "Resource location.", +"type": "string" +}, "resourceId": { "$ref": "DatabaseResourceId", "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": "SignalMetadata" +}, +"type": "array" +}, "signalState": { "description": "Required. Output only. Signal state of the signal", "enum": [ @@ -3326,7 +3368,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.", @@ -3336,7 +3381,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" } @@ -3834,7 +3882,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries", +"description": "Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries", "type": "object" }, "redisVersion": { @@ -5247,6 +5295,21 @@ false }, "type": "object" }, +"SignalMetadata": { +"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": "SignalMetadata", +"properties": { +"backupRun": { +"$ref": "BackupRun", +"description": "Signal data for backup runs." +}, +"signalBoolValue": { +"description": "Signal data for boolean signals.", +"type": "boolean" +} +}, +"type": "object" +}, "StateInfo": { "description": "Represents additional information about the state of the cluster.", "id": "StateInfo", From afe9f8a85609e6b7bb2b4e4a5930aa59fad8511f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 27/31] feat(run): update the api #### run:v2 The following keys were added: - schemas.GoogleCloudRunV2InlinedSource (Total Keys: 4) - schemas.GoogleCloudRunV2SourceCode.properties.inlinedSource.$ref (Total Keys: 1) - schemas.GoogleCloudRunV2SourceFile (Total Keys: 4) --- .../dyn/run_v1.namespaces.configurations.html | 4 +- docs/dyn/run_v1.namespaces.executions.html | 6 +-- docs/dyn/run_v1.namespaces.instances.html | 12 +++--- docs/dyn/run_v1.namespaces.jobs.html | 14 +++---- docs/dyn/run_v1.namespaces.revisions.html | 4 +- docs/dyn/run_v1.namespaces.services.html | 12 +++--- docs/dyn/run_v1.namespaces.tasks.html | 4 +- docs/dyn/run_v1.namespaces.workerpools.html | 12 +++--- ..._v1.projects.locations.configurations.html | 4 +- .../run_v1.projects.locations.revisions.html | 4 +- .../run_v1.projects.locations.services.html | 12 +++--- .../run_v2.projects.locations.instances.html | 30 ++++++++++++-- ...v2.projects.locations.jobs.executions.html | 20 +++++++++- ...jects.locations.jobs.executions.tasks.html | 20 +++++++++- docs/dyn/run_v2.projects.locations.jobs.html | 40 +++++++++++++++++-- .../run_v2.projects.locations.services.html | 40 +++++++++++++++++-- ...projects.locations.services.revisions.html | 20 +++++++++- ...run_v2.projects.locations.workerPools.html | 40 +++++++++++++++++-- ...jects.locations.workerPools.revisions.html | 20 +++++++++- .../discovery_cache/documents/run.v1.json | 4 +- .../discovery_cache/documents/run.v2.json | 37 ++++++++++++++++- 21 files changed, 288 insertions(+), 71 deletions(-) diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html index 5461ff75ea..c0dbea4456 100644 --- a/docs/dyn/run_v1.namespaces.configurations.html +++ b/docs/dyn/run_v1.namespaces.configurations.html @@ -349,7 +349,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -703,7 +703,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index 279d035ef2..ca7ce10d5f 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -325,7 +325,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -687,7 +687,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1010,7 +1010,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.instances.html b/docs/dyn/run_v1.namespaces.instances.html index e2a274197c..b66df2cdc6 100644 --- a/docs/dyn/run_v1.namespaces.instances.html +++ b/docs/dyn/run_v1.namespaces.instances.html @@ -321,7 +321,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -616,7 +616,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -962,7 +962,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1274,7 +1274,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1593,7 +1593,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1901,7 +1901,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index bd931466d0..f72403cd63 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -361,7 +361,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -705,7 +705,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1100,7 +1100,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1461,7 +1461,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1818,7 +1818,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2162,7 +2162,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2520,7 +2520,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index 9e4e989642..346bc756df 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -363,7 +363,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -683,7 +683,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index 800b6e5c0c..088561bbdd 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -353,7 +353,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -715,7 +715,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1128,7 +1128,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1506,7 +1506,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1880,7 +1880,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2242,7 +2242,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index 41471808ce..25128f0516 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -314,7 +314,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -641,7 +641,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.workerpools.html b/docs/dyn/run_v1.namespaces.workerpools.html index 8e9b7424b9..115adf7787 100644 --- a/docs/dyn/run_v1.namespaces.workerpools.html +++ b/docs/dyn/run_v1.namespaces.workerpools.html @@ -360,7 +360,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -712,7 +712,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1112,7 +1112,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1476,7 +1476,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1840,7 +1840,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2192,7 +2192,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index af9f4b3e7a..744f49f1ce 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -349,7 +349,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -703,7 +703,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index 2e5746e7a8..8c76f5cfff 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -363,7 +363,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -683,7 +683,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index 5990d95e40..3e86d05cea 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -362,7 +362,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -724,7 +724,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1137,7 +1137,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1563,7 +1563,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1937,7 +1937,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2299,7 +2299,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.instances.html b/docs/dyn/run_v2.projects.locations.instances.html index 124a5f6623..03d1e22d4b 100644 --- a/docs/dyn/run_v2.projects.locations.instances.html +++ b/docs/dyn/run_v2.projects.locations.instances.html @@ -237,6 +237,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -265,7 +273,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -573,6 +581,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -601,7 +617,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -847,6 +863,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -875,7 +899,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html index 00f283eea5..47b528ffaf 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html @@ -375,6 +375,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -403,7 +411,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -632,6 +640,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -660,7 +676,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html index e232795f0b..11e6522fc0 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -218,6 +218,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -246,7 +254,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -480,6 +488,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -508,7 +524,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index 2f9ccaf12d..fe7ad552a5 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -282,6 +282,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -310,7 +318,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -628,6 +636,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -656,7 +672,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -960,6 +976,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -988,7 +1012,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1251,6 +1275,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -1279,7 +1311,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 5a076c13a9..d8b93269bb 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -298,6 +298,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -326,7 +334,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -701,6 +709,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -729,7 +745,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1091,6 +1107,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -1119,7 +1143,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1441,6 +1465,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -1469,7 +1501,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index 02a0e86ed6..a7849ced99 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -298,6 +298,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -326,7 +334,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -560,6 +568,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -588,7 +604,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.html b/docs/dyn/run_v2.projects.locations.workerPools.html index 697117f239..156a1d0733 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.html @@ -286,6 +286,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -314,7 +322,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -645,6 +653,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -673,7 +689,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -991,6 +1007,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -1019,7 +1043,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1294,6 +1318,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -1322,7 +1354,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html index 3129e76bd0..45e7277fde 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html @@ -259,6 +259,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -287,7 +295,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -521,6 +529,14 @@

Method Details

"generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "sources": [ # Required. Input only. The source code. + { # Source file. + "content": "A String", # Required. Input only. The source code as raw text. + "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file. + }, + ], + }, }, "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. @@ -549,7 +565,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 114c3062d2..0e45adb236 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -3583,7 +3583,7 @@ } } }, -"revision": "20260227", +"revision": "20260306", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -7758,7 +7758,7 @@ false "type": "boolean" }, "subPath": { -"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).", +"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root). This field is currently ignored for Secret volumes.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index d0aaf41b51..ffafb1cb24 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -2473,7 +2473,7 @@ } } }, -"revision": "20260227", +"revision": "20260306", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -3463,6 +3463,20 @@ }, "type": "object" }, +"GoogleCloudRunV2InlinedSource": { +"description": "Inlined source.", +"id": "GoogleCloudRunV2InlinedSource", +"properties": { +"sources": { +"description": "Required. Input only. The source code.", +"items": { +"$ref": "GoogleCloudRunV2SourceFile" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudRunV2Instance": { "description": "A Cloud Run Instance represents a single group of containers running in a region.", "id": "GoogleCloudRunV2Instance", @@ -4981,6 +4995,25 @@ "cloudStorageSource": { "$ref": "GoogleCloudRunV2CloudStorageSource", "description": "The source is a Cloud Storage bucket." +}, +"inlinedSource": { +"$ref": "GoogleCloudRunV2InlinedSource", +"description": "Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source." +} +}, +"type": "object" +}, +"GoogleCloudRunV2SourceFile": { +"description": "Source file.", +"id": "GoogleCloudRunV2SourceFile", +"properties": { +"content": { +"description": "Required. Input only. The source code as raw text.", +"type": "string" +}, +"filename": { +"description": "Required. Input only. The file name for the source code. e.g., `\"index.js\"` or `\"node_modules/dependency.js\"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file.", +"type": "string" } }, "type": "object" @@ -5565,7 +5598,7 @@ "type": "string" }, "subPath": { -"description": "Optional. Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).", +"description": "Optional. Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root). This field is currently ignored for Secret volumes.", "type": "string" } }, From 0fb2f3b7531fb0a8694737ad7603841aefd2ab72 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 28/31] feat(searchads360): update the api #### searchads360:v0 The following keys were added: - schemas.GoogleAdsSearchads360V0Common__Segments.properties.adFormatType.type (Total Keys: 1) - schemas.GoogleAdsSearchads360V0Common__Segments.properties.verticalAdsEventParticipantDisplayNames.type (Total Keys: 1) - schemas.GoogleAdsSearchads360V0Common__Segments.properties.verticalAdsHotelClass (Total Keys: 2) - schemas.GoogleAdsSearchads360V0Common__Segments.properties.verticalAdsListing (Total Keys: 5) - schemas.GoogleAdsSearchads360V0Common__Segments.properties.verticalAdsPartnerAccount (Total Keys: 2) - schemas.GoogleAdsSearchads360V0Common__Segments.properties.verticalAdsVertical.type (Total Keys: 1) --- ...earchads360_v0.customers.searchAds360.html | 76 +++++---- .../documents/searchads360.v0.json | 148 +++++++++++++++--- 2 files changed, 173 insertions(+), 51 deletions(-) diff --git a/docs/dyn/searchads360_v0.customers.searchAds360.html b/docs/dyn/searchads360_v0.customers.searchAds360.html index 0fe3cc23d4..cf43f2c61a 100644 --- a/docs/dyn/searchads360_v0.customers.searchAds360.html +++ b/docs/dyn/searchads360_v0.customers.searchAds360.html @@ -183,7 +183,7 @@

Method Details

}, "adGroup": { # An ad group. # The ad group referenced in the query. "adRotationMode": "A String", # The ad rotation mode of the ad group. - "cpcBidMicros": "A String", # The maximum CPC (cost-per-click) bid. + "cpcBidMicros": "A String", # The maximum CPC (cost-per-click) bid. This field is used when the ad group's effective bidding strategy is Manual CPC. This field is not applicable and will be ignored if the ad group's campaign is using a portfolio bidding strategy. "creationTime": "A String", # Output only. The timestamp when this ad_group was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. "effectiveLabels": [ # Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group. "A String", @@ -770,8 +770,8 @@

Method Details

"networkSettings": { # The network settings for the campaign. # The network settings for the campaign. "targetContentNetwork": True or False, # Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion. "targetGoogleSearch": True or False, # Whether ads will be served with google.com search results. - "targetPartnerSearchNetwork": True or False, # Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts. - "targetSearchNetwork": True or False, # Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`). + "targetPartnerSearchNetwork": True or False, # Whether ads will be served on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google Search Partners Network; use `target_search_network` for that instead. + "targetSearchNetwork": True or False, # Whether ads will be served on sites in the Google Search Partners Network (requires `target_google_search` to also be `true`). }, "optimizationGoalSetting": { # Optimization goal setting for this campaign, which includes a set of optimization goal types. # Optimization goal setting for this campaign, which includes a set of optimization goal types. "optimizationGoalTypes": [ # The list of optimization goal types. @@ -851,7 +851,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the campaign audience view. Campaign audience view resource names have the form: `customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}` }, "campaignBudget": { # A campaign budget. # The campaign budget referenced in the query. - "amountMicros": "A String", # The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount. + "amountMicros": "A String", # The average daily amount to be spent by the campaign. This field is used when the CampaignBudget `period` is set to `DAILY`, which is the default. Amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. The effective monthly spend is capped at 30.4 times this daily amount. This field is mutually exclusive with 'total_amount_micros'. Only one of 'amount_micros' or 'total_amount_micros' should be set. "deliveryMethod": "A String", # The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation. "period": "A String", # Immutable. Period over which to spend the budget. Defaults to DAILY if not specified. "resourceName": "A String", # Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: `customers/{customer_id}/campaignBudgets/{campaign_budget_id}` @@ -921,7 +921,7 @@

Method Details

"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. Name of the resource. Campaign label resource names have the form: `customers/{owner_customer_id}/campaignLabels/{campaign_id}~{label_id}` }, - "cartDataSalesView": { # Cart data sales view. # The cart data sales view referenced in the query. + "cartDataSalesView": { # Cart data sales view. Provides information about the products which were purchased if conversions with cart data is implemented. Performance metrics like revenue, gross profit, lead/cross-sell metrics etc. and Merchant Center attributes such as brand, category etc. are available for products defined in an inventory feed and sold as a result of Google ads. For purchases attributed to clicks on Shopping ads, dimensions of both clicked and sold products can be viewed together. # The cart data sales view referenced in the query. "resourceName": "A String", # Output only. The resource name of the Cart data sales view. Cart data sales view resource names have the form: `customers/{customer_id}/cartDataSalesView` }, "conversion": { # A conversion. # The event level conversion referenced in the query. @@ -1121,15 +1121,15 @@

Method Details

"absoluteTopImpressionPercentage": 3.14, # Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position. "allConversions": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. - "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. - "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only. + "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a business during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. + "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only. "allConversionsFromInteractionsRate": 3.14, # All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. "allConversionsFromInteractionsValuePerInteraction": 3.14, # The value of all conversions from interactions divided by the total number of interactions. - "allConversionsFromMenu": 3.14, # The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only. - "allConversionsFromOrder": 3.14, # The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only. - "allConversionsFromOtherEngagement": 3.14, # The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only. - "allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only. - "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only. + "allConversionsFromMenu": 3.14, # The number of times people clicked a link to view a business's menu after clicking an ad. This metric applies to feed items only. + "allConversionsFromOrder": 3.14, # The number of times people placed an order at a business after clicking an ad. This metric applies to feed items only. + "allConversionsFromOtherEngagement": 3.14, # The number of other conversions (for example, posting a review or saving a location for a business) that occurred after people clicked an ad. This metric applies to feed items only. + "allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only. + "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only. "allConversionsValue": 3.14, # The value of all conversions. "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. "allConversionsValuePerCost": 3.14, # The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). @@ -1251,6 +1251,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the product group view. Product group view resource names have the form: `customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}` }, "segments": { # Segment only fields. # The segments. + "adFormatType": "A String", # Ad Format type. "adNetworkType": "A String", # Ad network type. "assetInteractionTarget": { # An AssetInteractionTarget segment. # Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. Interactions (for example, clicks) are counted across all the parts of the served ad (for example, Ad itself and other components like Sitelinks) when they are served together. When interaction_on_this_asset is true, it means the interactions are on this specific asset and when interaction_on_this_asset is false, it means the interactions is not on this specific asset but on other parts of the served ad this asset is served with. "asset": "A String", # The asset resource name. @@ -1338,15 +1339,24 @@

Method Details

"stringValue": "A String", # A string. }, ], + "verticalAdsEventParticipantDisplayNames": "A String", # The display names of participants in an event listing, like performers, speakers, or teams. + "verticalAdsHotelClass": "A String", # The class of the hotel. Generally in the range of 1 to 5 stars, but fully customizable in the hotel feed. + "verticalAdsListing": "A String", # The listing associated with a listing impression, click or conversion. + "verticalAdsListingBrand": "A String", # The brand associated with a specific listing within a Vertical Ads context, for example, the brand of a car rental, a vacation home, or an event. + "verticalAdsListingCity": "A String", # The city where the vertical ads listing is located. + "verticalAdsListingCountry": "A String", # The country where the vertical ads listing is located. + "verticalAdsListingRegion": "A String", # The region where the vertical ads listing is located. + "verticalAdsPartnerAccount": "A String", # A specific partner account within a Partner Center (for example, Hotel Center) that supplies inventory feed data for Vertical Ads. + "verticalAdsVertical": "A String", # Type of vertical ad, such as Vacation Rentals, Car Rentals, or Events, used to categorize and segment data in the context of Vertical Ads. "week": "A String", # Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd. "year": 42, # Year, formatted as yyyy. }, "shoppingPerformanceView": { # Shopping performance view. Provides Shopping campaign and Performance Max campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition, and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded. The number of impressions and clicks that `shopping_performance_view` returns stats for may be different from campaign reports. `shopping_performance_view` shows impressions and clicks on products appearing in ads, while campaign reports show impressions and clicks on the ads themselves. Depending on the format, an ad can show from zero to several products, so the numbers may not match. In Search Ads 360 UI, you can query impressions and clicks of products appearing in ads by selecting a column from "Product attributes" in the report editor. For example, selecting the "Brand" column is equivalent to selecting `segments.product_brand`. # The shopping performance view referenced in the query. "resourceName": "A String", # Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: `customers/{customer_id}/shoppingPerformanceView` }, - "userList": { # A user list. This is a list of users a customer may target. # The user list referenced in the query. + "userList": { # A user list. This is a list of users a customer may target. The unique key of a user list consists of the following fields: `id`. Note that the `name` must also be unique for user lists owned by a given customer, except in some cases where `access_reason` is set to `SHARED`. Violating the unique name constraint produces error: `UserListError.INVALID_NAME`. # The user list referenced in the query. "id": "A String", # Output only. Id of the user list. - "name": "A String", # Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED) + "name": "A String", # Name of this user list. Unique per user list, except in some cases where a user list of the same name has `access_reason` set to `SHARED`. "resourceName": "A String", # Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}` "type": "A String", # Output only. Type of this list. This field is read-only. }, @@ -1409,7 +1419,7 @@

Method Details

}, "adGroup": { # An ad group. # The ad group referenced in the query. "adRotationMode": "A String", # The ad rotation mode of the ad group. - "cpcBidMicros": "A String", # The maximum CPC (cost-per-click) bid. + "cpcBidMicros": "A String", # The maximum CPC (cost-per-click) bid. This field is used when the ad group's effective bidding strategy is Manual CPC. This field is not applicable and will be ignored if the ad group's campaign is using a portfolio bidding strategy. "creationTime": "A String", # Output only. The timestamp when this ad_group was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. "effectiveLabels": [ # Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group. "A String", @@ -1996,8 +2006,8 @@

Method Details

"networkSettings": { # The network settings for the campaign. # The network settings for the campaign. "targetContentNetwork": True or False, # Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion. "targetGoogleSearch": True or False, # Whether ads will be served with google.com search results. - "targetPartnerSearchNetwork": True or False, # Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts. - "targetSearchNetwork": True or False, # Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`). + "targetPartnerSearchNetwork": True or False, # Whether ads will be served on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google Search Partners Network; use `target_search_network` for that instead. + "targetSearchNetwork": True or False, # Whether ads will be served on sites in the Google Search Partners Network (requires `target_google_search` to also be `true`). }, "optimizationGoalSetting": { # Optimization goal setting for this campaign, which includes a set of optimization goal types. # Optimization goal setting for this campaign, which includes a set of optimization goal types. "optimizationGoalTypes": [ # The list of optimization goal types. @@ -2077,7 +2087,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the campaign audience view. Campaign audience view resource names have the form: `customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}` }, "campaignBudget": { # A campaign budget. # The campaign budget referenced in the query. - "amountMicros": "A String", # The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount. + "amountMicros": "A String", # The average daily amount to be spent by the campaign. This field is used when the CampaignBudget `period` is set to `DAILY`, which is the default. Amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. The effective monthly spend is capped at 30.4 times this daily amount. This field is mutually exclusive with 'total_amount_micros'. Only one of 'amount_micros' or 'total_amount_micros' should be set. "deliveryMethod": "A String", # The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation. "period": "A String", # Immutable. Period over which to spend the budget. Defaults to DAILY if not specified. "resourceName": "A String", # Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: `customers/{customer_id}/campaignBudgets/{campaign_budget_id}` @@ -2147,7 +2157,7 @@

Method Details

"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label. "resourceName": "A String", # Immutable. Name of the resource. Campaign label resource names have the form: `customers/{owner_customer_id}/campaignLabels/{campaign_id}~{label_id}` }, - "cartDataSalesView": { # Cart data sales view. # The cart data sales view referenced in the query. + "cartDataSalesView": { # Cart data sales view. Provides information about the products which were purchased if conversions with cart data is implemented. Performance metrics like revenue, gross profit, lead/cross-sell metrics etc. and Merchant Center attributes such as brand, category etc. are available for products defined in an inventory feed and sold as a result of Google ads. For purchases attributed to clicks on Shopping ads, dimensions of both clicked and sold products can be viewed together. # The cart data sales view referenced in the query. "resourceName": "A String", # Output only. The resource name of the Cart data sales view. Cart data sales view resource names have the form: `customers/{customer_id}/cartDataSalesView` }, "conversion": { # A conversion. # The event level conversion referenced in the query. @@ -2347,15 +2357,15 @@

Method Details

"absoluteTopImpressionPercentage": 3.14, # Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position. "allConversions": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. - "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. - "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only. + "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a business during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. + "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only. "allConversionsFromInteractionsRate": 3.14, # All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. "allConversionsFromInteractionsValuePerInteraction": 3.14, # The value of all conversions from interactions divided by the total number of interactions. - "allConversionsFromMenu": 3.14, # The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only. - "allConversionsFromOrder": 3.14, # The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only. - "allConversionsFromOtherEngagement": 3.14, # The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only. - "allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only. - "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only. + "allConversionsFromMenu": 3.14, # The number of times people clicked a link to view a business's menu after clicking an ad. This metric applies to feed items only. + "allConversionsFromOrder": 3.14, # The number of times people placed an order at a business after clicking an ad. This metric applies to feed items only. + "allConversionsFromOtherEngagement": 3.14, # The number of other conversions (for example, posting a review or saving a location for a business) that occurred after people clicked an ad. This metric applies to feed items only. + "allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only. + "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only. "allConversionsValue": 3.14, # The value of all conversions. "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. "allConversionsValuePerCost": 3.14, # The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). @@ -2477,6 +2487,7 @@

Method Details

"resourceName": "A String", # Output only. The resource name of the product group view. Product group view resource names have the form: `customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}` }, "segments": { # Segment only fields. # The segments. + "adFormatType": "A String", # Ad Format type. "adNetworkType": "A String", # Ad network type. "assetInteractionTarget": { # An AssetInteractionTarget segment. # Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. Interactions (for example, clicks) are counted across all the parts of the served ad (for example, Ad itself and other components like Sitelinks) when they are served together. When interaction_on_this_asset is true, it means the interactions are on this specific asset and when interaction_on_this_asset is false, it means the interactions is not on this specific asset but on other parts of the served ad this asset is served with. "asset": "A String", # The asset resource name. @@ -2564,15 +2575,24 @@

Method Details

"stringValue": "A String", # A string. }, ], + "verticalAdsEventParticipantDisplayNames": "A String", # The display names of participants in an event listing, like performers, speakers, or teams. + "verticalAdsHotelClass": "A String", # The class of the hotel. Generally in the range of 1 to 5 stars, but fully customizable in the hotel feed. + "verticalAdsListing": "A String", # The listing associated with a listing impression, click or conversion. + "verticalAdsListingBrand": "A String", # The brand associated with a specific listing within a Vertical Ads context, for example, the brand of a car rental, a vacation home, or an event. + "verticalAdsListingCity": "A String", # The city where the vertical ads listing is located. + "verticalAdsListingCountry": "A String", # The country where the vertical ads listing is located. + "verticalAdsListingRegion": "A String", # The region where the vertical ads listing is located. + "verticalAdsPartnerAccount": "A String", # A specific partner account within a Partner Center (for example, Hotel Center) that supplies inventory feed data for Vertical Ads. + "verticalAdsVertical": "A String", # Type of vertical ad, such as Vacation Rentals, Car Rentals, or Events, used to categorize and segment data in the context of Vertical Ads. "week": "A String", # Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd. "year": 42, # Year, formatted as yyyy. }, "shoppingPerformanceView": { # Shopping performance view. Provides Shopping campaign and Performance Max campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition, and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded. The number of impressions and clicks that `shopping_performance_view` returns stats for may be different from campaign reports. `shopping_performance_view` shows impressions and clicks on products appearing in ads, while campaign reports show impressions and clicks on the ads themselves. Depending on the format, an ad can show from zero to several products, so the numbers may not match. In Search Ads 360 UI, you can query impressions and clicks of products appearing in ads by selecting a column from "Product attributes" in the report editor. For example, selecting the "Brand" column is equivalent to selecting `segments.product_brand`. # The shopping performance view referenced in the query. "resourceName": "A String", # Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: `customers/{customer_id}/shoppingPerformanceView` }, - "userList": { # A user list. This is a list of users a customer may target. # The user list referenced in the query. + "userList": { # A user list. This is a list of users a customer may target. The unique key of a user list consists of the following fields: `id`. Note that the `name` must also be unique for user lists owned by a given customer, except in some cases where `access_reason` is set to `SHARED`. Violating the unique name constraint produces error: `UserListError.INVALID_NAME`. # The user list referenced in the query. "id": "A String", # Output only. Id of the user list. - "name": "A String", # Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED) + "name": "A String", # Name of this user list. Unique per user list, except in some cases where a user list of the same name has `access_reason` set to `SHARED`. "resourceName": "A String", # Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}` "type": "A String", # Output only. Type of this list. This field is read-only. }, diff --git a/googleapiclient/discovery_cache/documents/searchads360.v0.json b/googleapiclient/discovery_cache/documents/searchads360.v0.json index b7e7f3a317..acc717e78c 100644 --- a/googleapiclient/discovery_cache/documents/searchads360.v0.json +++ b/googleapiclient/discovery_cache/documents/searchads360.v0.json @@ -260,7 +260,7 @@ } } }, -"revision": "20251211", +"revision": "20260307", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -448,7 +448,17 @@ "AD_IMAGE", "LEAD_FORM", "BUSINESS_LOGO", -"DESCRIPTION_PREFIX" +"DESCRIPTION_PREFIX", +"APP_ICON", +"APP_TITLE", +"APP_SCREENSHOT", +"APP_COVER_PHOTO", +"APP_SHORT_DESCRIPTION", +"APP_DEVELOPER_NAME", +"HEADLINE_AS_SITELINK_POSITION_ONE", +"HEADLINE_AS_SITELINK_POSITION_TWO", +"DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_ONE", +"DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_TWO" ], "enumDescriptions": [ "No value has been specified.", @@ -483,7 +493,17 @@ "This asset is used as an image.", "The asset is used as a lead form.", "The asset is used as a business logo.", -"The asset is used as a description prefix." +"The asset is used as a description prefix.", +"The asset is used as an app icon.", +"The asset is used as an app title.", +"The asset is used as an app screenshot.", +"The asset is used as an app cover photo.", +"The asset is used as an app short description.", +"The asset is used as an app developer name.", +"A headline asset used as a sitelink in position 1.", +"A headline asset used as a sitelink in position 2.", +"A description line asset used as a sitelink in position 1.", +"A description line asset used as a sitelink in position 2." ], "type": "string" } @@ -978,12 +998,12 @@ "type": "number" }, "allConversionsFromClickToCall": { -"description": "The number of times people clicked the \"Call\" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.", +"description": "The number of times people clicked the \"Call\" button to call a business during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.", "format": "double", "type": "number" }, "allConversionsFromDirections": { -"description": "The number of times people clicked a \"Get directions\" button to navigate to a store after clicking an ad. This metric applies to feed items only.", +"description": "The number of times people clicked a \"Get directions\" button to navigate to a business after clicking an ad. This metric applies to feed items only.", "format": "double", "type": "number" }, @@ -998,27 +1018,27 @@ "type": "number" }, "allConversionsFromMenu": { -"description": "The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.", +"description": "The number of times people clicked a link to view a business's menu after clicking an ad. This metric applies to feed items only.", "format": "double", "type": "number" }, "allConversionsFromOrder": { -"description": "The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.", +"description": "The number of times people placed an order at a business after clicking an ad. This metric applies to feed items only.", "format": "double", "type": "number" }, "allConversionsFromOtherEngagement": { -"description": "The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.", +"description": "The number of other conversions (for example, posting a review or saving a location for a business) that occurred after people clicked an ad. This metric applies to feed items only.", "format": "double", "type": "number" }, "allConversionsFromStoreVisit": { -"description": "Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.", +"description": "Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only.", "format": "double", "type": "number" }, "allConversionsFromStoreWebsite": { -"description": "The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.", +"description": "The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only.", "format": "double", "type": "number" }, @@ -1716,6 +1736,24 @@ "description": "Segment only fields.", "id": "GoogleAdsSearchads360V0Common__Segments", "properties": { +"adFormatType": { +"description": "Ad Format type.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"VERTICAL_ADS_PROMOTION", +"VERTICAL_ADS_BOOKING_LINK", +"TEXT" +], +"enumDescriptions": [ +"No value has been specified.", +"Used for return value only. Represents value unknown in this version.", +"An ad format that promotes a specific entity within a vertical, for example, a hotel ad in the Travel vertical on Search.", +"An ad format for a booking link call-to-action within a vertical ad, for example a 'Book Now' link for a hotel ad.", +"A standard text ad format. This is currently only used for ads on the Search network." +], +"type": "string" +}, "adNetworkType": { "description": "Ad network type.", "enum": [ @@ -1774,7 +1812,8 @@ "STORE_VISIT", "STORE_SALE", "QUALIFIED_LEAD", -"CONVERTED_LEAD" +"CONVERTED_LEAD", +"YOUTUBE_FOLLOW_ON_VIEWS" ], "enumDescriptions": [ "Not specified.", @@ -1800,7 +1839,8 @@ "A visit to a physical store location.", "A sale occurring in a physical store.", "A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser (marketing/sales team). In the lead-to-sale journey, advertisers get leads, then act on them by reaching out to the consumer. If the consumer is interested and may end up buying their product, the advertiser marks such leads as \"qualified leads\".", -"A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser." +"A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser.", +"User watches an ad from a channel and later watches either the same video or a video from the same channel as the ad." ], "type": "string" }, @@ -2139,6 +2179,64 @@ }, "type": "array" }, +"verticalAdsEventParticipantDisplayNames": { +"description": "The display names of participants in an event listing, like performers, speakers, or teams.", +"type": "string" +}, +"verticalAdsHotelClass": { +"description": "The class of the hotel. Generally in the range of 1 to 5 stars, but fully customizable in the hotel feed.", +"format": "int64", +"type": "string" +}, +"verticalAdsListing": { +"description": "The listing associated with a listing impression, click or conversion.", +"type": "string" +}, +"verticalAdsListingBrand": { +"description": "The brand associated with a specific listing within a Vertical Ads context, for example, the brand of a car rental, a vacation home, or an event.", +"type": "string" +}, +"verticalAdsListingCity": { +"description": "The city where the vertical ads listing is located.", +"type": "string" +}, +"verticalAdsListingCountry": { +"description": "The country where the vertical ads listing is located.", +"type": "string" +}, +"verticalAdsListingRegion": { +"description": "The region where the vertical ads listing is located.", +"type": "string" +}, +"verticalAdsPartnerAccount": { +"description": "A specific partner account within a Partner Center (for example, Hotel Center) that supplies inventory feed data for Vertical Ads.", +"format": "int64", +"type": "string" +}, +"verticalAdsVertical": { +"description": "Type of vertical ad, such as Vacation Rentals, Car Rentals, or Events, used to categorize and segment data in the context of Vertical Ads.", +"enum": [ +"UNSPECIFIED", +"UNKNOWN", +"HOTELS", +"VACATION_RENTALS", +"RENTAL_CARS", +"EVENTS", +"THINGS_TO_DO", +"FLIGHTS" +], +"enumDescriptions": [ +"Not specified.", +"Used for return value only. Represents value unknown in this version.", +"Hotels travel vertical.", +"Vacation rentals travel vertical.", +"Rental cars travel vertical.", +"Events travel vertical.", +"Things to do travel vertical.", +"Flights travel vertical." +], +"type": "string" +}, "week": { "description": "Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.", "type": "string" @@ -2996,7 +3094,8 @@ "UNRECOGNIZED_FIELD", "UNEXPECTED_INPUT", "REQUESTED_METRICS_FOR_MANAGER", -"FILTER_HAS_TOO_MANY_VALUES" +"FILTER_HAS_TOO_MANY_VALUES", +"REQUIRED_SEGMENT_FIELD_MISSING" ], "enumDescriptions": [ "Name unspecified.", @@ -3055,7 +3154,8 @@ "Query contains one or more unrecognized fields.", "Query has an unexpected extra part.", "Metrics cannot be requested for a manager account. To retrieve metrics, issue separate requests against each client account under the manager account.", -"The number of values (right-hand-side operands) in a filter exceeds the limit." +"The number of values (right-hand-side operands) in a filter exceeds the limit.", +"Required segment field is missing." ], "type": "string" }, @@ -3476,11 +3576,11 @@ "type": "boolean" }, "targetPartnerSearchNetwork": { -"description": "Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.", +"description": "Whether ads will be served on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google Search Partners Network; use `target_search_network` for that instead.", "type": "boolean" }, "targetSearchNetwork": { -"description": "Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`).", +"description": "Whether ads will be served on sites in the Google Search Partners Network (requires `target_google_search` to also be `true`).", "type": "boolean" } }, @@ -4168,7 +4268,7 @@ "type": "string" }, "cpcBidMicros": { -"description": "The maximum CPC (cost-per-click) bid.", +"description": "The maximum CPC (cost-per-click) bid. This field is used when the ad group's effective bidding strategy is Manual CPC. This field is not applicable and will be ignored if the ad group's campaign is using a portfolio bidding strategy.", "format": "int64", "type": "string" }, @@ -6487,7 +6587,7 @@ false "id": "GoogleAdsSearchads360V0Resources__CampaignBudget", "properties": { "amountMicros": { -"description": "The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.", +"description": "The average daily amount to be spent by the campaign. This field is used when the CampaignBudget `period` is set to `DAILY`, which is the default. Amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. The effective monthly spend is capped at 30.4 times this daily amount. This field is mutually exclusive with 'total_amount_micros'. Only one of 'amount_micros' or 'total_amount_micros' should be set.", "format": "int64", "type": "string" }, @@ -6762,7 +6862,7 @@ false "type": "object" }, "GoogleAdsSearchads360V0Resources__CartDataSalesView": { -"description": "Cart data sales view.", +"description": "Cart data sales view. Provides information about the products which were purchased if conversions with cart data is implemented. Performance metrics like revenue, gross profit, lead/cross-sell metrics etc. and Merchant Center attributes such as brand, category etc. are available for products defined in an inventory feed and sold as a result of Google ads. For purchases attributed to clicks on Shopping ads, dimensions of both clicked and sold products can be viewed together.", "id": "GoogleAdsSearchads360V0Resources__CartDataSalesView", "properties": { "resourceName": { @@ -7051,7 +7151,8 @@ false "STORE_VISIT", "STORE_SALE", "QUALIFIED_LEAD", -"CONVERTED_LEAD" +"CONVERTED_LEAD", +"YOUTUBE_FOLLOW_ON_VIEWS" ], "enumDescriptions": [ "Not specified.", @@ -7077,7 +7178,8 @@ false "A visit to a physical store location.", "A sale occurring in a physical store.", "A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser (marketing/sales team). In the lead-to-sale journey, advertisers get leads, then act on them by reaching out to the consumer. If the consumer is interested and may end up buying their product, the advertiser marks such leads as \"qualified leads\".", -"A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser." +"A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser.", +"User watches an ad from a channel and later watches either the same video or a video from the same channel as the ad." ], "type": "string" }, @@ -8463,7 +8565,7 @@ false "type": "object" }, "GoogleAdsSearchads360V0Resources__UserList": { -"description": "A user list. This is a list of users a customer may target.", +"description": "A user list. This is a list of users a customer may target. The unique key of a user list consists of the following fields: `id`. Note that the `name` must also be unique for user lists owned by a given customer, except in some cases where `access_reason` is set to `SHARED`. Violating the unique name constraint produces error: `UserListError.INVALID_NAME`.", "id": "GoogleAdsSearchads360V0Resources__UserList", "properties": { "id": { @@ -8473,7 +8575,7 @@ false "type": "string" }, "name": { -"description": "Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)", +"description": "Name of this user list. Unique per user list, except in some cases where a user list of the same name has `access_reason` set to `SHARED`.", "type": "string" }, "resourceName": { From fb1d3d2bcfbb453a5acd52963479cdb1c540e5ee Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 29/31] fix(sts): update the api #### sts:v1 The following keys were changed: - endpoints (Total Keys: 1) #### sts:v1beta The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/sts.v1.json | 12 +++++++++++- .../discovery_cache/documents/sts.v1beta.json | 12 +++++++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index 311919a64a..d468444c79 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -59,6 +59,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://sts.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://sts.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1" }, @@ -79,6 +84,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://sts.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://sts.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1" }, @@ -343,7 +353,7 @@ } } }, -"revision": "20251203", +"revision": "20260304", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1beta.json b/googleapiclient/discovery_cache/documents/sts.v1beta.json index a854517de4..186a2a9c74 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1beta.json +++ b/googleapiclient/discovery_cache/documents/sts.v1beta.json @@ -59,6 +59,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://sts.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://sts.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1" }, @@ -79,6 +84,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://sts.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://sts.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1" }, @@ -343,7 +353,7 @@ } } }, -"revision": "20251203", +"revision": "20260304", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { From 565e85ee7c6ff98c849d1834712c35449f77cbf1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:46 +0000 Subject: [PATCH 30/31] feat(workloadmanager): update the api #### workloadmanager:v1 The following keys were deleted: - schemas.Evaluation.properties.ruleVersions (Total Keys: 3) - schemas.InvalidRule (Total Keys: 10) - schemas.ListRulesResponse.properties.invalidRulesWrapper.$ref (Total Keys: 1) - schemas.ResourceStatus.properties.rulesNewerVersions (Total Keys: 3) --- ...ects.locations.evaluations.executions.html | 192 ++++----- ...ations.evaluations.executions.results.html | 28 +- ...aluations.executions.scannedResources.html | 16 +- ...ger_v1.projects.locations.evaluations.html | 212 +++++----- ...admanager_v1.projects.locations.rules.html | 51 +-- .../documents/workloadmanager.v1.json | 363 +++++++----------- 6 files changed, 376 insertions(+), 486 deletions(-) diff --git a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html index bd0a2dca8e..19fc5079a2 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html @@ -113,7 +113,7 @@

Method Details

Deletes a single Execution.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  name: string, Required. Name of the resource. (required)
   requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
@@ -149,7 +149,7 @@ 

Method Details

Gets details of a single Execution.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  name: string, Required. Name of the resource. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -158,45 +158,45 @@ 

Method Details

Returns: An object of the form: - { # Message describing Execution object - "endTime": "A String", # Output only. [Output only] End time stamp - "engine": "A String", # Optional. Engine - "evaluationId": "A String", # Output only. [Output only] Evaluation ID - "externalDataSources": [ # Optional. External data sources - { # Message for external data sources + { # Execution that represents a single run of an Evaluation. + "endTime": "A String", # Output only. [Output only] End time stamp. + "engine": "A String", # Optional. Engine. + "evaluationId": "A String", # Output only. [Output only] Evaluation ID. + "externalDataSources": [ # Optional. External data sources. + { # External data sources for an execution. "assetType": "A String", # Required. The asset type of the external data source. This can be a supported Cloud Asset Inventory asset type (see https://cloud.google.com/asset-inventory/docs/supported-asset-types) to override the default asset type, or it can be a custom type defined by the user. - "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data - "type": "A String", # Required. Type of external data source - "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID} + "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data. + "type": "A String", # Required. Type of external data source. + "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}. }, ], - "inventoryTime": "A String", # Output only. [Output only] Inventory time stamp - "labels": { # Labels as key value pairs + "inventoryTime": "A String", # Output only. [Output only] Inventory time stamp. + "labels": { # Labels as key value pairs. "a_key": "A String", }, - "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution} - "notices": [ # Output only. Additional information generated by the execution - { # Message for additional information generated by the execution - "message": "A String", # Output only. Message of the notice + "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}. + "notices": [ # Output only. Additional information generated by the execution. + { # Additional information generated by an execution. + "message": "A String", # Output only. Message of the notice. }, ], - "resultSummary": { # Message for execution summary # Output only. [Output only] Result summary for the execution - "failures": "A String", # Output only. Number of failures - "newFailures": "A String", # Output only. Number of new failures compared to the previous execution - "newFixes": "A String", # Output only. Number of new fixes compared to the previous execution + "resultSummary": { # Execution summary. # Output only. [Output only] Result summary for the execution. + "failures": "A String", # Output only. Number of failures. + "newFailures": "A String", # Output only. Number of new failures compared to the previous execution. + "newFixes": "A String", # Output only. Number of new fixes compared to the previous execution. }, - "ruleResults": [ # Output only. execution result summary per rule - { # Message for execution result summary per rule - "message": "A String", # Execution message, if any - "resultCount": "A String", # Number of violations - "rule": "A String", # rule name - "scannedResourceCount": "A String", # Number of total scanned resources - "state": "A String", # Output only. The execution status + "ruleResults": [ # Output only. Execution result summary per rule. + { # Execution result summary per rule. + "message": "A String", # Execution message, if any. + "resultCount": "A String", # Number of violations. + "rule": "A String", # Rule name as plain text like `sap-hana-configured`. + "scannedResourceCount": "A String", # Number of total scanned resources. + "state": "A String", # Output only. The execution status. }, ], - "runType": "A String", # type represent whether the execution executed directly by user or scheduled according evaluation.schedule field. - "startTime": "A String", # Output only. [Output only] Start time stamp - "state": "A String", # Output only. [Output only] State + "runType": "A String", # Type which represents whether the execution executed directly by user or scheduled according to the `Evaluation.schedule` field. + "startTime": "A String", # Output only. [Output only] Start time stamp. + "state": "A String", # Output only. [Output only] State. }
@@ -205,8 +205,8 @@

Method Details

Lists Executions in a given project and location.
 
 Args:
-  parent: string, Required. The resource prefix of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}' (required)
-  filter: string, Filtering results
+  parent: string, Required. The resource prefix of the Execution using the form: `projects/{project}/locations/{location}/evaluations/{evaluation}`. (required)
+  filter: string, Filtering results.
   orderBy: string, Field to sort by. See https://google.aip.dev/132#ordering for more details.
   pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
   pageToken: string, A token identifying a page of results the server should return.
@@ -218,47 +218,47 @@ 

Method Details

Returns: An object of the form: - { # Message for response to listing Executions - "executions": [ # The list of Execution - { # Message describing Execution object - "endTime": "A String", # Output only. [Output only] End time stamp - "engine": "A String", # Optional. Engine - "evaluationId": "A String", # Output only. [Output only] Evaluation ID - "externalDataSources": [ # Optional. External data sources - { # Message for external data sources + { # Response message for the ListExecutions RPC. + "executions": [ # The list of Execution. + { # Execution that represents a single run of an Evaluation. + "endTime": "A String", # Output only. [Output only] End time stamp. + "engine": "A String", # Optional. Engine. + "evaluationId": "A String", # Output only. [Output only] Evaluation ID. + "externalDataSources": [ # Optional. External data sources. + { # External data sources for an execution. "assetType": "A String", # Required. The asset type of the external data source. This can be a supported Cloud Asset Inventory asset type (see https://cloud.google.com/asset-inventory/docs/supported-asset-types) to override the default asset type, or it can be a custom type defined by the user. - "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data - "type": "A String", # Required. Type of external data source - "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID} + "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data. + "type": "A String", # Required. Type of external data source. + "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}. }, ], - "inventoryTime": "A String", # Output only. [Output only] Inventory time stamp - "labels": { # Labels as key value pairs + "inventoryTime": "A String", # Output only. [Output only] Inventory time stamp. + "labels": { # Labels as key value pairs. "a_key": "A String", }, - "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution} - "notices": [ # Output only. Additional information generated by the execution - { # Message for additional information generated by the execution - "message": "A String", # Output only. Message of the notice + "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}. + "notices": [ # Output only. Additional information generated by the execution. + { # Additional information generated by an execution. + "message": "A String", # Output only. Message of the notice. }, ], - "resultSummary": { # Message for execution summary # Output only. [Output only] Result summary for the execution - "failures": "A String", # Output only. Number of failures - "newFailures": "A String", # Output only. Number of new failures compared to the previous execution - "newFixes": "A String", # Output only. Number of new fixes compared to the previous execution + "resultSummary": { # Execution summary. # Output only. [Output only] Result summary for the execution. + "failures": "A String", # Output only. Number of failures. + "newFailures": "A String", # Output only. Number of new failures compared to the previous execution. + "newFixes": "A String", # Output only. Number of new fixes compared to the previous execution. }, - "ruleResults": [ # Output only. execution result summary per rule - { # Message for execution result summary per rule - "message": "A String", # Execution message, if any - "resultCount": "A String", # Number of violations - "rule": "A String", # rule name - "scannedResourceCount": "A String", # Number of total scanned resources - "state": "A String", # Output only. The execution status + "ruleResults": [ # Output only. Execution result summary per rule. + { # Execution result summary per rule. + "message": "A String", # Execution message, if any. + "resultCount": "A String", # Number of violations. + "rule": "A String", # Rule name as plain text like `sap-hana-configured`. + "scannedResourceCount": "A String", # Number of total scanned resources. + "state": "A String", # Output only. The execution status. }, ], - "runType": "A String", # type represent whether the execution executed directly by user or scheduled according evaluation.schedule field. - "startTime": "A String", # Output only. [Output only] Start time stamp - "state": "A String", # Output only. [Output only] State + "runType": "A String", # Type which represents whether the execution executed directly by user or scheduled according to the `Evaluation.schedule` field. + "startTime": "A String", # Output only. [Output only] Start time stamp. + "state": "A String", # Output only. [Output only] State. }, ], "nextPageToken": "A String", # A token identifying a page of results the server should return. @@ -287,52 +287,52 @@

Method Details

Creates a new Execution in a given project and location.
 
 Args:
-  name: string, Required. The resource name of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}' (required)
+  name: string, Required. The resource name of the Evaluation using the form: `projects/{project}/locations/{location}/evaluations/{evaluation}`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Message for creating a Execution
-  "execution": { # Message describing Execution object # Required. The resource being created
-    "endTime": "A String", # Output only. [Output only] End time stamp
-    "engine": "A String", # Optional. Engine
-    "evaluationId": "A String", # Output only. [Output only] Evaluation ID
-    "externalDataSources": [ # Optional. External data sources
-      { # Message for external data sources
+{ # Request message for the RunEvaluation RPC.
+  "execution": { # Execution that represents a single run of an Evaluation. # Required. The resource being created.
+    "endTime": "A String", # Output only. [Output only] End time stamp.
+    "engine": "A String", # Optional. Engine.
+    "evaluationId": "A String", # Output only. [Output only] Evaluation ID.
+    "externalDataSources": [ # Optional. External data sources.
+      { # External data sources for an execution.
         "assetType": "A String", # Required. The asset type of the external data source. This can be a supported Cloud Asset Inventory asset type (see https://cloud.google.com/asset-inventory/docs/supported-asset-types) to override the default asset type, or it can be a custom type defined by the user.
-        "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data
-        "type": "A String", # Required. Type of external data source
-        "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}
+        "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data.
+        "type": "A String", # Required. Type of external data source.
+        "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}.
       },
     ],
-    "inventoryTime": "A String", # Output only. [Output only] Inventory time stamp
-    "labels": { # Labels as key value pairs
+    "inventoryTime": "A String", # Output only. [Output only] Inventory time stamp.
+    "labels": { # Labels as key value pairs.
       "a_key": "A String",
     },
-    "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}
-    "notices": [ # Output only. Additional information generated by the execution
-      { # Message for additional information generated by the execution
-        "message": "A String", # Output only. Message of the notice
+    "name": "A String", # The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}.
+    "notices": [ # Output only. Additional information generated by the execution.
+      { # Additional information generated by an execution.
+        "message": "A String", # Output only. Message of the notice.
       },
     ],
-    "resultSummary": { # Message for execution summary # Output only. [Output only] Result summary for the execution
-      "failures": "A String", # Output only. Number of failures
-      "newFailures": "A String", # Output only. Number of new failures compared to the previous execution
-      "newFixes": "A String", # Output only. Number of new fixes compared to the previous execution
+    "resultSummary": { # Execution summary. # Output only. [Output only] Result summary for the execution.
+      "failures": "A String", # Output only. Number of failures.
+      "newFailures": "A String", # Output only. Number of new failures compared to the previous execution.
+      "newFixes": "A String", # Output only. Number of new fixes compared to the previous execution.
     },
-    "ruleResults": [ # Output only. execution result summary per rule
-      { # Message for execution result summary per rule
-        "message": "A String", # Execution message, if any
-        "resultCount": "A String", # Number of violations
-        "rule": "A String", # rule name
-        "scannedResourceCount": "A String", # Number of total scanned resources
-        "state": "A String", # Output only. The execution status
+    "ruleResults": [ # Output only. Execution result summary per rule.
+      { # Execution result summary per rule.
+        "message": "A String", # Execution message, if any.
+        "resultCount": "A String", # Number of violations.
+        "rule": "A String", # Rule name as plain text like `sap-hana-configured`.
+        "scannedResourceCount": "A String", # Number of total scanned resources.
+        "state": "A String", # Output only. The execution status.
       },
     ],
-    "runType": "A String", # type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.
-    "startTime": "A String", # Output only. [Output only] Start time stamp
-    "state": "A String", # Output only. [Output only] State
+    "runType": "A String", # Type which represents whether the execution executed directly by user or scheduled according to the `Evaluation.schedule` field.
+    "startTime": "A String", # Output only. [Output only] Start time stamp.
+    "state": "A String", # Output only. [Output only] State.
   },
-  "executionId": "A String", # Required. Id of the requesting object If auto-generating Id server-side, remove this field and execution_id from the method_signature of Create RPC
+  "executionId": "A String", # Required. ID of the execution which will be created.
   "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
 }
 
diff --git a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.results.html b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.results.html
index 22bf977312..4d8d3d5fd2 100644
--- a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.results.html
+++ b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.results.html
@@ -94,8 +94,8 @@ 

Method Details

Lists the result of a single evaluation.
 
 Args:
-  parent: string, Required. The execution results. Format: {parent}/evaluations/*/executions/*/results (required)
-  filter: string, Filtering results
+  parent: string, Required. The execution results. Format: {parent}/evaluations/*/executions/*/results. (required)
+  filter: string, Filtering results.
   pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
   pageToken: string, A token identifying a page of results the server should return.
   x__xgafv: string, V1 error format.
@@ -106,34 +106,34 @@ 

Method Details

Returns: An object of the form: - { # Message for response of list execution results + { # Response message for the ListExecutionResults RPC. "executionResults": [ # The versions from the specified publisher. - { # Message describing the result of an execution + { # The result of an execution. "commands": [ # The commands to remediate the violation. - { # * Command specifies the type of command to execute. - "agentCommand": { # * An AgentCommand specifies a one-time executable program for the agent to run. # AgentCommand specifies a one-time executable program for the agent to run. - "command": "A String", # command is the name of the agent one-time executable that will be invoked. - "parameters": { # parameters is a map of key/value pairs that can be used to specify additional one-time executable settings. + { # Command specifies the type of command to execute. + "agentCommand": { # An AgentCommand specifies a one-time executable program for the agent to run. # AgentCommand specifies a one-time executable program for the agent to run. + "command": "A String", # The name of the agent one-time executable that will be invoked. + "parameters": { # A map of key/value pairs that can be used to specify additional one-time executable settings. "a_key": "A String", }, }, - "shellCommand": { # * A ShellCommand is invoked via the agent's command line executor # ShellCommand is invoked via the agent's command line executor. - "args": "A String", # args is a string of arguments to be passed to the command. - "command": "A String", # command is the name of the command to be executed. + "shellCommand": { # A ShellCommand is invoked via the agent's command line executor. # ShellCommand is invoked via the agent's command line executor. + "args": "A String", # Arguments to be passed to the command. + "command": "A String", # The name of the command to be executed. "timeoutSeconds": 42, # Optional. If not specified, the default timeout is 60 seconds. }, }, ], "documentationUrl": "A String", # The URL for the documentation of the rule. - "resource": { # Message represent resource in execution result # The resource that violates the rule. + "resource": { # Resource in execution result. # The resource that violates the rule. "name": "A String", # The name of the resource. "serviceAccount": "A String", # The service account associated with the resource. "type": "A String", # The type of resource. }, "rule": "A String", # The rule that is violated in an evaluation. "severity": "A String", # The severity of violation. - "type": "A String", # Execution result type of the scanned resource - "violationDetails": { # Message describing the violation in an evaluation result. # The details of violation in an evaluation result. + "type": "A String", # Execution result type of the scanned resource. + "violationDetails": { # The violation in an evaluation result. # The details of violation in an evaluation result. "asset": "A String", # The name of the asset. "observed": { # Details of the violation. "a_key": "A String", diff --git a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.scannedResources.html b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.scannedResources.html index 5f4892e217..1d0f1d0cc8 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.scannedResources.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.scannedResources.html @@ -94,12 +94,12 @@

Method Details

List all scanned resources for a single Execution.
 
 Args:
-  parent: string, Required. parent for ListScannedResourcesRequest (required)
-  filter: string, Filtering results
+  parent: string, Required. Parent for ListScannedResourcesRequest. (required)
+  filter: string, Filtering results.
   orderBy: string, Field to sort by. See https://google.aip.dev/132#ordering for more details.
   pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
   pageToken: string, A token identifying a page of results the server should return.
-  rule: string, rule name
+  rule: string, Rule name.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -108,12 +108,12 @@ 

Method Details

Returns: An object of the form: - { # Message for response to list scanned resources + { # Response message for the ListScannedResources RPC. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - "scannedResources": [ # All scanned resources in response - { # Message of scanned resource - "resource": "A String", # resource name - "type": "A String", # resource type + "scannedResources": [ # All scanned resources in response. + { # A scanned resource. + "resource": "A String", # Resource name. + "type": "A String", # Resource type. }, ], }
diff --git a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.html b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.html index 8491a4e507..a667db4b99 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.html @@ -111,57 +111,51 @@

Method Details

Creates a new Evaluation in a given project and location.
 
 Args:
-  parent: string, Required. The resource prefix of the evaluation location using the form: `projects/{project_id}/locations/{location_id}` (required)
+  parent: string, Required. The resource prefix of the evaluation location using the form: `projects/{project_id}/locations/{location_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Message describing Evaluation object
-  "bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination
-    "createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table
-    "destinationDataset": "A String", # Optional. destination dataset to save evaluation results
+{ # Represents a Workload Manager Evaluation configuration. An Evaluation defines a set of rules to be validated against a scope of Cloud resources.
+  "bigQueryDestination": { # BigQuery destination for evaluation results. # Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery.
+    "createNewResultsTable": True or False, # Optional. Determines if a new results table will be created when an Execution is created.
+    "destinationDataset": "A String", # Optional. Destination dataset to save evaluation results.
   },
-  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "createTime": "A String", # Output only. [Output only] Create time stamp.
   "customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules.
-  "description": "A String", # Description of the Evaluation
-  "evaluationType": "A String", # Evaluation type
-  "kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
-  "labels": { # Labels as key value pairs
+  "description": "A String", # Description of the Evaluation.
+  "evaluationType": "A String", # Evaluation type.
+  "kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. The key will be used for CMEK encryption of the evaluation resource.
+  "labels": { # Labels as key value pairs.
     "a_key": "A String",
   },
-  "name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
-  "resourceFilter": { # Message describing resource filters # annotations as key value pairs
-    "gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource
-      "serviceAccounts": [ # Service account of compute engine
+  "name": "A String", # Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.
+  "resourceFilter": { # Resource filter for an evaluation defining the scope of resources to be evaluated. # Resource filter for an evaluation defining the scope of resources to be evaluated.
+    "gceInstanceFilter": { # A filter for matching Compute Engine instances. # Filter compute engine resources.
+      "serviceAccounts": [ # If non-empty, only Compute Engine instances associated with at least one of the provided service accounts will be included in the evaluation.
         "A String",
       ],
     },
-    "inclusionLabels": { # The label used for filter resource
+    "inclusionLabels": { # Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying `{ "env": "prod", "database": "nosql" }` will only include resources that have labels `env=prod` and `database=nosql`.
       "a_key": "A String",
     },
-    "resourceIdPatterns": [ # The id pattern for filter resource
+    "resourceIdPatterns": [ # The pattern to filter resources by their id For example, a pattern of ".*prod-cluster.*" will match all resources that contain "prod-cluster" in their ID.
       "A String",
     ],
-    "scopes": [ # The scopes of evaluation resource
+    "scopes": [ # The scopes of evaluation resource. Format: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`
       "A String",
     ],
   },
-  "resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist.
-    "rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists
-      "A String",
-    ],
-    "state": "A String", # State of the resource
+  "resourceStatus": { # The lifecycle status of an Evaluation resource. # Output only. [Output only] The current lifecycle state of the evaluation resource.
+    "state": "A String", # State of the Evaluation resource.
   },
-  "ruleNames": [ # the name of the rule
-    "A String",
-  ],
-  "ruleVersions": [ # Output only. [Output only] The updated rule ids if exist.
+  "ruleNames": [ # The names of the rules used for this evaluation.
     "A String",
   ],
-  "schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
-  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "schedule": "A String", # Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * `0 */1 * * *` # Hourly * `0 */6 * * *` # Every 6 hours * `0 */12 * * *` # Every 12 hours * `0 0 */1 * *` # Daily * `0 0 */7 * *` # Weekly * `0 0 */14 * *` # Every 14 days * `0 0 1 */1 *` # Monthly
+  "updateTime": "A String", # Output only. [Output only] Update time stamp.
 }
 
-  evaluationId: string, Required. Id of the requesting object
+  evaluationId: string, Required. Id of the requesting object.
   requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
@@ -197,8 +191,8 @@ 

Method Details

Deletes a single Evaluation.
 
 Args:
-  name: string, Required. Name of the resource (required)
-  force: boolean, Optional. Followed the best practice from https://aip.dev/135#cascading-delete
+  name: string, Required. Name of the resource. (required)
+  force: boolean, Optional. Followed the best practice from https://aip.dev/135#cascading-delete.
   requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
@@ -234,7 +228,7 @@ 

Method Details

Gets details of a single Evaluation.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  name: string, Required. Name of the resource. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -243,50 +237,44 @@ 

Method Details

Returns: An object of the form: - { # Message describing Evaluation object - "bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination - "createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table - "destinationDataset": "A String", # Optional. destination dataset to save evaluation results + { # Represents a Workload Manager Evaluation configuration. An Evaluation defines a set of rules to be validated against a scope of Cloud resources. + "bigQueryDestination": { # BigQuery destination for evaluation results. # Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery. + "createNewResultsTable": True or False, # Optional. Determines if a new results table will be created when an Execution is created. + "destinationDataset": "A String", # Optional. Destination dataset to save evaluation results. }, - "createTime": "A String", # Output only. [Output only] Create time stamp + "createTime": "A String", # Output only. [Output only] Create time stamp. "customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules. - "description": "A String", # Description of the Evaluation - "evaluationType": "A String", # Evaluation type - "kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. - "labels": { # Labels as key value pairs + "description": "A String", # Description of the Evaluation. + "evaluationType": "A String", # Evaluation type. + "kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. The key will be used for CMEK encryption of the evaluation resource. + "labels": { # Labels as key value pairs. "a_key": "A String", }, - "name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}' - "resourceFilter": { # Message describing resource filters # annotations as key value pairs - "gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource - "serviceAccounts": [ # Service account of compute engine + "name": "A String", # Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`. + "resourceFilter": { # Resource filter for an evaluation defining the scope of resources to be evaluated. # Resource filter for an evaluation defining the scope of resources to be evaluated. + "gceInstanceFilter": { # A filter for matching Compute Engine instances. # Filter compute engine resources. + "serviceAccounts": [ # If non-empty, only Compute Engine instances associated with at least one of the provided service accounts will be included in the evaluation. "A String", ], }, - "inclusionLabels": { # The label used for filter resource + "inclusionLabels": { # Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying `{ "env": "prod", "database": "nosql" }` will only include resources that have labels `env=prod` and `database=nosql`. "a_key": "A String", }, - "resourceIdPatterns": [ # The id pattern for filter resource + "resourceIdPatterns": [ # The pattern to filter resources by their id For example, a pattern of ".*prod-cluster.*" will match all resources that contain "prod-cluster" in their ID. "A String", ], - "scopes": [ # The scopes of evaluation resource + "scopes": [ # The scopes of evaluation resource. Format: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` "A String", ], }, - "resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist. - "rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists - "A String", - ], - "state": "A String", # State of the resource + "resourceStatus": { # The lifecycle status of an Evaluation resource. # Output only. [Output only] The current lifecycle state of the evaluation resource. + "state": "A String", # State of the Evaluation resource. }, - "ruleNames": [ # the name of the rule - "A String", - ], - "ruleVersions": [ # Output only. [Output only] The updated rule ids if exist. + "ruleNames": [ # The names of the rules used for this evaluation. "A String", ], - "schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *", - "updateTime": "A String", # Output only. [Output only] Update time stamp + "schedule": "A String", # Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * `0 */1 * * *` # Hourly * `0 */6 * * *` # Every 6 hours * `0 */12 * * *` # Every 12 hours * `0 0 */1 * *` # Daily * `0 0 */7 * *` # Weekly * `0 0 */14 * *` # Every 14 days * `0 0 1 */1 *` # Monthly + "updateTime": "A String", # Output only. [Output only] Update time stamp. }
@@ -295,9 +283,9 @@

Method Details

Lists Evaluations in a given project and location.
 
 Args:
-  parent: string, Required. Parent value for ListEvaluationsRequest (required)
+  parent: string, Required. Parent value for ListEvaluationsRequest. (required)
   filter: string, Filter to be applied when listing the evaluation results.
-  orderBy: string, Hint for how to order the results
+  orderBy: string, Hint for how to order the results.
   pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
   pageToken: string, A token identifying a page of results the server should return.
   x__xgafv: string, V1 error format.
@@ -308,52 +296,46 @@ 

Method Details

Returns: An object of the form: - { # Message for response to listing Evaluations - "evaluations": [ # The list of Evaluation - { # Message describing Evaluation object - "bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination - "createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table - "destinationDataset": "A String", # Optional. destination dataset to save evaluation results + { # Response message for the ListEvaluations RPC. + "evaluations": [ # The list of evaluations. + { # Represents a Workload Manager Evaluation configuration. An Evaluation defines a set of rules to be validated against a scope of Cloud resources. + "bigQueryDestination": { # BigQuery destination for evaluation results. # Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery. + "createNewResultsTable": True or False, # Optional. Determines if a new results table will be created when an Execution is created. + "destinationDataset": "A String", # Optional. Destination dataset to save evaluation results. }, - "createTime": "A String", # Output only. [Output only] Create time stamp + "createTime": "A String", # Output only. [Output only] Create time stamp. "customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules. - "description": "A String", # Description of the Evaluation - "evaluationType": "A String", # Evaluation type - "kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. - "labels": { # Labels as key value pairs + "description": "A String", # Description of the Evaluation. + "evaluationType": "A String", # Evaluation type. + "kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. The key will be used for CMEK encryption of the evaluation resource. + "labels": { # Labels as key value pairs. "a_key": "A String", }, - "name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}' - "resourceFilter": { # Message describing resource filters # annotations as key value pairs - "gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource - "serviceAccounts": [ # Service account of compute engine + "name": "A String", # Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`. + "resourceFilter": { # Resource filter for an evaluation defining the scope of resources to be evaluated. # Resource filter for an evaluation defining the scope of resources to be evaluated. + "gceInstanceFilter": { # A filter for matching Compute Engine instances. # Filter compute engine resources. + "serviceAccounts": [ # If non-empty, only Compute Engine instances associated with at least one of the provided service accounts will be included in the evaluation. "A String", ], }, - "inclusionLabels": { # The label used for filter resource + "inclusionLabels": { # Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying `{ "env": "prod", "database": "nosql" }` will only include resources that have labels `env=prod` and `database=nosql`. "a_key": "A String", }, - "resourceIdPatterns": [ # The id pattern for filter resource + "resourceIdPatterns": [ # The pattern to filter resources by their id For example, a pattern of ".*prod-cluster.*" will match all resources that contain "prod-cluster" in their ID. "A String", ], - "scopes": [ # The scopes of evaluation resource + "scopes": [ # The scopes of evaluation resource. Format: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}` "A String", ], }, - "resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist. - "rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists - "A String", - ], - "state": "A String", # State of the resource + "resourceStatus": { # The lifecycle status of an Evaluation resource. # Output only. [Output only] The current lifecycle state of the evaluation resource. + "state": "A String", # State of the Evaluation resource. }, - "ruleNames": [ # the name of the rule - "A String", - ], - "ruleVersions": [ # Output only. [Output only] The updated rule ids if exist. + "ruleNames": [ # The names of the rules used for this evaluation. "A String", ], - "schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *", - "updateTime": "A String", # Output only. [Output only] Update time stamp + "schedule": "A String", # Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * `0 */1 * * *` # Hourly * `0 */6 * * *` # Every 6 hours * `0 */12 * * *` # Every 12 hours * `0 0 */1 * *` # Daily * `0 0 */7 * *` # Weekly * `0 0 */14 * *` # Every 14 days * `0 0 1 */1 *` # Monthly + "updateTime": "A String", # Output only. [Output only] Update time stamp. }, ], "nextPageToken": "A String", # A token identifying a page of results the server should return. @@ -382,54 +364,48 @@

Method Details

Updates the parameters of a single Evaluation.
 
 Args:
-  name: string, name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}' (required)
+  name: string, Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Message describing Evaluation object
-  "bigQueryDestination": { # Message describing big query destination # Optional. BigQuery destination
-    "createNewResultsTable": True or False, # Optional. determine if results will be saved in a new table
-    "destinationDataset": "A String", # Optional. destination dataset to save evaluation results
+{ # Represents a Workload Manager Evaluation configuration. An Evaluation defines a set of rules to be validated against a scope of Cloud resources.
+  "bigQueryDestination": { # BigQuery destination for evaluation results. # Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery.
+    "createNewResultsTable": True or False, # Optional. Determines if a new results table will be created when an Execution is created.
+    "destinationDataset": "A String", # Optional. Destination dataset to save evaluation results.
   },
-  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "createTime": "A String", # Output only. [Output only] Create time stamp.
   "customRulesBucket": "A String", # The Cloud Storage bucket name for custom rules.
-  "description": "A String", # Description of the Evaluation
-  "evaluationType": "A String", # Evaluation type
-  "kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
-  "labels": { # Labels as key value pairs
+  "description": "A String", # Description of the Evaluation.
+  "evaluationType": "A String", # Evaluation type.
+  "kmsKey": "A String", # Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. The key will be used for CMEK encryption of the evaluation resource.
+  "labels": { # Labels as key value pairs.
     "a_key": "A String",
   },
-  "name": "A String", # name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
-  "resourceFilter": { # Message describing resource filters # annotations as key value pairs
-    "gceInstanceFilter": { # Message describing compute engine instance filter # Filter compute engine resource
-      "serviceAccounts": [ # Service account of compute engine
+  "name": "A String", # Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.
+  "resourceFilter": { # Resource filter for an evaluation defining the scope of resources to be evaluated. # Resource filter for an evaluation defining the scope of resources to be evaluated.
+    "gceInstanceFilter": { # A filter for matching Compute Engine instances. # Filter compute engine resources.
+      "serviceAccounts": [ # If non-empty, only Compute Engine instances associated with at least one of the provided service accounts will be included in the evaluation.
         "A String",
       ],
     },
-    "inclusionLabels": { # The label used for filter resource
+    "inclusionLabels": { # Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying `{ "env": "prod", "database": "nosql" }` will only include resources that have labels `env=prod` and `database=nosql`.
       "a_key": "A String",
     },
-    "resourceIdPatterns": [ # The id pattern for filter resource
+    "resourceIdPatterns": [ # The pattern to filter resources by their id For example, a pattern of ".*prod-cluster.*" will match all resources that contain "prod-cluster" in their ID.
       "A String",
     ],
-    "scopes": [ # The scopes of evaluation resource
+    "scopes": [ # The scopes of evaluation resource. Format: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`
       "A String",
     ],
   },
-  "resourceStatus": { # Message describing resource status # Output only. [Output only] The updated rule ids if exist.
-    "rulesNewerVersions": [ # Historical: Used before 2023-05-22 the new version of rule id if exists
-      "A String",
-    ],
-    "state": "A String", # State of the resource
+  "resourceStatus": { # The lifecycle status of an Evaluation resource. # Output only. [Output only] The current lifecycle state of the evaluation resource.
+    "state": "A String", # State of the Evaluation resource.
   },
-  "ruleNames": [ # the name of the rule
-    "A String",
-  ],
-  "ruleVersions": [ # Output only. [Output only] The updated rule ids if exist.
+  "ruleNames": [ # The names of the rules used for this evaluation.
     "A String",
   ],
-  "schedule": "A String", # crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
-  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "schedule": "A String", # Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * `0 */1 * * *` # Hourly * `0 */6 * * *` # Every 6 hours * `0 */12 * * *` # Every 12 hours * `0 0 */1 * *` # Daily * `0 0 */7 * *` # Weekly * `0 0 */14 * *` # Every 14 days * `0 0 1 */1 *` # Monthly
+  "updateTime": "A String", # Output only. [Output only] Update time stamp.
 }
 
   requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
diff --git a/docs/dyn/workloadmanager_v1.projects.locations.rules.html b/docs/dyn/workloadmanager_v1.projects.locations.rules.html
index 67d8073a46..5986f7398b 100644
--- a/docs/dyn/workloadmanager_v1.projects.locations.rules.html
+++ b/docs/dyn/workloadmanager_v1.projects.locations.rules.html
@@ -91,16 +91,15 @@ 

Method Details

Lists rules in a given project.
 
 Args:
-  parent: string, Required. The [project] on which to execute the request. The format is: projects/{project_id}/locations/{location} Currently, the pre-defined rules are global available to all projects and all regions (required)
+  parent: string, Required. The [project] on which to execute the request. The format is: projects/{project_id}/locations/{location} Currently, the pre-defined rules are global available to all projects and all regions. (required)
   customRulesBucket: string, The Cloud Storage bucket name for custom rules.
   evaluationType: string, Optional. The evaluation type of the rules will be applied to. The Cloud Storage bucket name for custom rules.
     Allowed values
-      EVALUATION_TYPE_UNSPECIFIED - Not specified
-      SAP - SAP best practices
-      SQL_SERVER - SQL best practices
-      OTHER - Customized best practices
-      SCC_IAC - SCC IaC (Infra as Code) best practices.
-  filter: string, Filter based on primary_category, secondary_category
+      EVALUATION_TYPE_UNSPECIFIED - Not specified.
+      SAP - SAP best practices.
+      SQL_SERVER - SQL best practices.
+      OTHER - Customized best practices.
+  filter: string, Filter based on primary_category, secondary_category.
   pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
   pageToken: string, A token identifying a page of results the server should return.
   x__xgafv: string, V1 error format.
@@ -111,34 +110,24 @@ 

Method Details

Returns: An object of the form: - { # Mesesage of response of list rules - "invalidRulesWrapper": { # Message wrappes a list of invalid rules. # A wrapper of the invalid rules that failed to be validated. - "invalidRules": [ # The invalid rules that failed to be validated. - { # Message represent an rule that failed to be validated. - "displayName": "A String", # display name of the invalid rule - "gcsUri": "A String", # cloud storage destination of the invalid rule - "name": "A String", # name of the invalid rule - "valiadtionError": "A String", # The error message of valdating rule formats. - }, - ], - }, - "rules": [ # all rules in response - { # Message represent a rule + { # Response message for the ListRules RPC. + "rules": [ # All rules in response. + { # A rule to be evaluated. "assetType": "A String", # The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types. - "description": "A String", # descrite rule in plain language - "displayName": "A String", # the name display in UI - "errorMessage": "A String", # the message template for rule - "name": "A String", # rule name - "primaryCategory": "A String", # the primary category - "remediation": "A String", # the remediation for the rule - "revisionId": "A String", # Output only. the version of the rule + "description": "A String", # Describe rule in plain language. + "displayName": "A String", # The name display in UI. + "errorMessage": "A String", # The message template for rule. + "name": "A String", # Rule name. + "primaryCategory": "A String", # The primary category. + "remediation": "A String", # The remediation for the rule. + "revisionId": "A String", # Output only. The version of the rule. "ruleType": "A String", # The type of the rule. - "secondaryCategory": "A String", # the secondary category - "severity": "A String", # the severity of the rule - "tags": [ # List of user-defined tags + "secondaryCategory": "A String", # The secondary category. + "severity": "A String", # The severity of the rule. + "tags": [ # List of user-defined tags. "A String", ], - "uri": "A String", # the docuement url for the rule + "uri": "A String", # The document url for the rule. }, ], }
diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index 35930ce3a8..0e0b224ae1 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -574,12 +574,12 @@ ], "parameters": { "evaluationId": { -"description": "Required. Id of the requesting object", +"description": "Required. Id of the requesting object.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource prefix of the evaluation location using the form: `projects/{project_id}/locations/{location_id}`", +"description": "Required. The resource prefix of the evaluation location using the form: `projects/{project_id}/locations/{location_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -612,12 +612,12 @@ ], "parameters": { "force": { -"description": "Optional. Followed the best practice from https://aip.dev/135#cascading-delete", +"description": "Optional. Followed the best practice from https://aip.dev/135#cascading-delete.", "location": "query", "type": "boolean" }, "name": { -"description": "Required. Name of the resource", +"description": "Required. Name of the resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "required": true, @@ -647,7 +647,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the resource", +"description": "Required. Name of the resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "required": true, @@ -677,7 +677,7 @@ "type": "string" }, "orderBy": { -"description": "Hint for how to order the results", +"description": "Hint for how to order the results.", "location": "query", "type": "string" }, @@ -693,7 +693,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent value for ListEvaluationsRequest", +"description": "Required. Parent value for ListEvaluationsRequest.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -718,7 +718,7 @@ ], "parameters": { "name": { -"description": "name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'", +"description": "Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "required": true, @@ -761,7 +761,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the resource", +"description": "Required. Name of the resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$", "required": true, @@ -791,7 +791,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the resource", +"description": "Required. Name of the resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$", "required": true, @@ -816,7 +816,7 @@ ], "parameters": { "filter": { -"description": "Filtering results", +"description": "Filtering results.", "location": "query", "type": "string" }, @@ -837,7 +837,7 @@ "type": "string" }, "parent": { -"description": "Required. The resource prefix of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}'", +"description": "Required. The resource prefix of the Execution using the form: `projects/{project}/locations/{location}/evaluations/{evaluation}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "required": true, @@ -862,7 +862,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}'", +"description": "Required. The resource name of the Evaluation using the form: `projects/{project}/locations/{location}/evaluations/{evaluation}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "required": true, @@ -894,7 +894,7 @@ ], "parameters": { "filter": { -"description": "Filtering results", +"description": "Filtering results.", "location": "query", "type": "string" }, @@ -910,7 +910,7 @@ "type": "string" }, "parent": { -"description": "Required. The execution results. Format: {parent}/evaluations/*/executions/*/results", +"description": "Required. The execution results. Format: {parent}/evaluations/*/executions/*/results.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$", "required": true, @@ -939,7 +939,7 @@ ], "parameters": { "filter": { -"description": "Filtering results", +"description": "Filtering results.", "location": "query", "type": "string" }, @@ -960,14 +960,14 @@ "type": "string" }, "parent": { -"description": "Required. parent for ListScannedResourcesRequest", +"description": "Required. Parent for ListScannedResourcesRequest.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$", "required": true, "type": "string" }, "rule": { -"description": "rule name", +"description": "Rule name.", "location": "query", "type": "string" } @@ -1198,28 +1198,19 @@ "EVALUATION_TYPE_UNSPECIFIED", "SAP", "SQL_SERVER", -"OTHER", -"SCC_IAC" -], -"enumDeprecated": [ -false, -false, -false, -false, -true +"OTHER" ], "enumDescriptions": [ -"Not specified", -"SAP best practices", -"SQL best practices", -"Customized best practices", -"SCC IaC (Infra as Code) best practices." +"Not specified.", +"SAP best practices.", +"SQL best practices.", +"Customized best practices." ], "location": "query", "type": "string" }, "filter": { -"description": "Filter based on primary_category, secondary_category", +"description": "Filter based on primary_category, secondary_category.", "location": "query", "type": "string" }, @@ -1235,7 +1226,7 @@ true "type": "string" }, "parent": { -"description": "Required. The [project] on which to execute the request. The format is: projects/{project_id}/locations/{location} Currently, the pre-defined rules are global available to all projects and all regions", +"description": "Required. The [project] on which to execute the request. The format is: projects/{project_id}/locations/{location} Currently, the pre-defined rules are global available to all projects and all regions.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1257,7 +1248,7 @@ true } } }, -"revision": "20260204", +"revision": "20260217", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -1442,18 +1433,18 @@ true "type": "object" }, "AgentCommand": { -"description": "* An AgentCommand specifies a one-time executable program for the agent to run.", +"description": "An AgentCommand specifies a one-time executable program for the agent to run.", "id": "AgentCommand", "properties": { "command": { -"description": "command is the name of the agent one-time executable that will be invoked.", +"description": "The name of the agent one-time executable that will be invoked.", "type": "string" }, "parameters": { "additionalProperties": { "type": "string" }, -"description": "parameters is a map of key/value pairs that can be used to specify additional one-time executable settings.", +"description": "A map of key/value pairs that can be used to specify additional one-time executable settings.", "type": "object" } }, @@ -1859,15 +1850,15 @@ true "type": "object" }, "BigQueryDestination": { -"description": "Message describing big query destination", +"description": "BigQuery destination for evaluation results.", "id": "BigQueryDestination", "properties": { "createNewResultsTable": { -"description": "Optional. determine if results will be saved in a new table", +"description": "Optional. Determines if a new results table will be created when an Execution is created.", "type": "boolean" }, "destinationDataset": { -"description": "Optional. destination dataset to save evaluation results", +"description": "Optional. Destination dataset to save evaluation results.", "type": "string" } }, @@ -1930,7 +1921,7 @@ true "type": "object" }, "Command": { -"description": "* Command specifies the type of command to execute.", +"description": "Command specifies the type of command to execute.", "id": "Command", "properties": { "agentCommand": { @@ -2253,15 +2244,15 @@ true "type": "object" }, "Evaluation": { -"description": "Message describing Evaluation object", +"description": "Represents a Workload Manager Evaluation configuration. An Evaluation defines a set of rules to be validated against a scope of Cloud resources.", "id": "Evaluation", "properties": { "bigQueryDestination": { "$ref": "BigQueryDestination", -"description": "Optional. BigQuery destination" +"description": "Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery." }, "createTime": { -"description": "Output only. [Output only] Create time stamp", +"description": "Output only. [Output only] Create time stamp.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2271,79 +2262,62 @@ true "type": "string" }, "description": { -"description": "Description of the Evaluation", +"description": "Description of the Evaluation.", "type": "string" }, "evaluationType": { -"description": "Evaluation type", +"description": "Evaluation type.", "enum": [ "EVALUATION_TYPE_UNSPECIFIED", "SAP", "SQL_SERVER", -"OTHER", -"SCC_IAC" -], -"enumDeprecated": [ -false, -false, -false, -false, -true +"OTHER" ], "enumDescriptions": [ -"Not specified", -"SAP best practices", -"SQL best practices", -"Customized best practices", -"SCC IaC (Infra as Code) best practices." +"Not specified.", +"SAP best practices.", +"SQL best practices.", +"Customized best practices." ], "type": "string" }, "kmsKey": { -"description": "Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.", +"description": "Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. The key will be used for CMEK encryption of the evaluation resource.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, -"description": "Labels as key value pairs", +"description": "Labels as key value pairs.", "type": "object" }, "name": { -"description": "name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'", +"description": "Name of resource that has the form `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.", "type": "string" }, "resourceFilter": { "$ref": "ResourceFilter", -"description": "annotations as key value pairs" +"description": "Resource filter for an evaluation defining the scope of resources to be evaluated." }, "resourceStatus": { "$ref": "ResourceStatus", -"description": "Output only. [Output only] The updated rule ids if exist.", +"description": "Output only. [Output only] The current lifecycle state of the evaluation resource.", "readOnly": true }, "ruleNames": { -"description": "the name of the rule", -"items": { -"type": "string" -}, -"type": "array" -}, -"ruleVersions": { -"description": "Output only. [Output only] The updated rule ids if exist.", +"description": "The names of the rules used for this evaluation.", "items": { "type": "string" }, -"readOnly": true, "type": "array" }, "schedule": { -"description": "crontab format schedule for scheduled evaluation, currently only support the following schedule: \"0 */1 * * *\", \"0 */6 * * *\", \"0 */12 * * *\", \"0 0 */1 * *\", \"0 0 */7 * *\",", +"description": "Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * `0 */1 * * *` # Hourly * `0 */6 * * *` # Every 6 hours * `0 */12 * * *` # Every 12 hours * `0 0 */1 * *` # Daily * `0 0 */7 * *` # Weekly * `0 0 */14 * *` # Every 14 days * `0 0 1 */1 *` # Monthly", "type": "string" }, "updateTime": { -"description": "Output only. [Output only] Update time stamp", +"description": "Output only. [Output only] Update time stamp.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2352,43 +2326,43 @@ true "type": "object" }, "Execution": { -"description": "Message describing Execution object", +"description": "Execution that represents a single run of an Evaluation.", "id": "Execution", "properties": { "endTime": { -"description": "Output only. [Output only] End time stamp", +"description": "Output only. [Output only] End time stamp.", "format": "google-datetime", "readOnly": true, "type": "string" }, "engine": { -"description": "Optional. Engine", +"description": "Optional. Engine.", "enum": [ "ENGINE_UNSPECIFIED", "ENGINE_SCANNER", "V2" ], "enumDescriptions": [ -"The original CG", -"SlimCG / Scanner", -"Evaluation Engine V2" +"The original CG.", +"SlimCG / Scanner.", +"Evaluation Engine V2." ], "type": "string" }, "evaluationId": { -"description": "Output only. [Output only] Evaluation ID", +"description": "Output only. [Output only] Evaluation ID.", "readOnly": true, "type": "string" }, "externalDataSources": { -"description": "Optional. External data sources", +"description": "Optional. External data sources.", "items": { "$ref": "ExternalDataSources" }, "type": "array" }, "inventoryTime": { -"description": "Output only. [Output only] Inventory time stamp", +"description": "Output only. [Output only] Inventory time stamp.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2397,15 +2371,15 @@ true "additionalProperties": { "type": "string" }, -"description": "Labels as key value pairs", +"description": "Labels as key value pairs.", "type": "object" }, "name": { -"description": "The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}", +"description": "The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}.", "type": "string" }, "notices": { -"description": "Output only. Additional information generated by the execution", +"description": "Output only. Additional information generated by the execution.", "items": { "$ref": "Notice" }, @@ -2414,11 +2388,11 @@ true }, "resultSummary": { "$ref": "Summary", -"description": "Output only. [Output only] Result summary for the execution", +"description": "Output only. [Output only] Result summary for the execution.", "readOnly": true }, "ruleResults": { -"description": "Output only. execution result summary per rule", +"description": "Output only. Execution result summary per rule.", "items": { "$ref": "RuleExecutionResult" }, @@ -2426,27 +2400,27 @@ true "type": "array" }, "runType": { -"description": "type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.", +"description": "Type which represents whether the execution executed directly by user or scheduled according to the `Evaluation.schedule` field.", "enum": [ "TYPE_UNSPECIFIED", "ONE_TIME", "SCHEDULED" ], "enumDescriptions": [ -"type of execution is unspecified", -"type of execution is one time", -"type of execution is scheduled" +"Type of execution is unspecified.", +"Type of execution is one time.", +"Type of execution is scheduled." ], "type": "string" }, "startTime": { -"description": "Output only. [Output only] Start time stamp", +"description": "Output only. [Output only] Start time stamp.", "format": "google-datetime", "readOnly": true, "type": "string" }, "state": { -"description": "Output only. [Output only] State", +"description": "Output only. [Output only] State.", "enum": [ "STATE_UNSPECIFIED", "RUNNING", @@ -2454,10 +2428,10 @@ true "FAILED" ], "enumDescriptions": [ -"state of execution is unspecified", -"the execution is running in backend service", -"the execution run success", -"the execution run failed" +"State of execution is unspecified.", +"The execution is running in backend service.", +"The execution run succeeded.", +"The execution run failed." ], "readOnly": true, "type": "string" @@ -2466,7 +2440,7 @@ true "type": "object" }, "ExecutionResult": { -"description": "Message describing the result of an execution", +"description": "The result of an execution.", "id": "ExecutionResult", "properties": { "commands": { @@ -2493,16 +2467,16 @@ true "type": "string" }, "type": { -"description": "Execution result type of the scanned resource", +"description": "Execution result type of the scanned resource.", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PASSED", "TYPE_VIOLATED" ], "enumDescriptions": [ -"Unknown state", -"resource successfully passed the rule", -"resource violated the rule" +"Unknown state.", +"Resource successfully passed the rule.", +"Resource violated the rule." ], "type": "string" }, @@ -2518,7 +2492,7 @@ true "type": "object" }, "ExternalDataSources": { -"description": "Message for external data sources", +"description": "External data sources for an execution.", "id": "ExternalDataSources", "properties": { "assetType": { @@ -2526,34 +2500,34 @@ true "type": "string" }, "name": { -"description": "Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data", +"description": "Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data.", "type": "string" }, "type": { -"description": "Required. Type of external data source", +"description": "Required. Type of external data source.", "enum": [ "TYPE_UNSPECIFIED", "BIG_QUERY_TABLE" ], "enumDescriptions": [ -"Unknown type", -"BigQuery table" +"Unknown type.", +"BigQuery table." ], "type": "string" }, "uri": { -"description": "Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}", +"description": "Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}.", "type": "string" } }, "type": "object" }, "GceInstanceFilter": { -"description": "Message describing compute engine instance filter", +"description": "A filter for matching Compute Engine instances.", "id": "GceInstanceFilter", "properties": { "serviceAccounts": { -"description": "Service account of compute engine", +"description": "If non-empty, only Compute Engine instances associated with at least one of the provided service accounts will be included in the evaluation.", "items": { "type": "string" }, @@ -2718,43 +2692,6 @@ true }, "type": "object" }, -"InvalidRule": { -"description": "Message represent an rule that failed to be validated.", -"id": "InvalidRule", -"properties": { -"displayName": { -"description": "display name of the invalid rule", -"type": "string" -}, -"gcsUri": { -"description": "cloud storage destination of the invalid rule", -"type": "string" -}, -"name": { -"description": "name of the invalid rule", -"type": "string" -}, -"valiadtionError": { -"description": "The error message of valdating rule formats.", -"type": "string" -} -}, -"type": "object" -}, -"InvalidRulesWrapper": { -"description": "Message wrappes a list of invalid rules.", -"id": "InvalidRulesWrapper", -"properties": { -"invalidRules": { -"description": "The invalid rules that failed to be validated.", -"items": { -"$ref": "InvalidRule" -}, -"type": "array" -} -}, -"type": "object" -}, "ListActuationsResponse": { "description": "The response object from `ListActuations`.", "id": "ListActuationsResponse", @@ -2833,11 +2770,11 @@ true "type": "object" }, "ListEvaluationsResponse": { -"description": "Message for response to listing Evaluations", +"description": "Response message for the ListEvaluations RPC.", "id": "ListEvaluationsResponse", "properties": { "evaluations": { -"description": "The list of Evaluation", +"description": "The list of evaluations.", "items": { "$ref": "Evaluation" }, @@ -2858,7 +2795,7 @@ true "type": "object" }, "ListExecutionResultsResponse": { -"description": "Message for response of list execution results", +"description": "Response message for the ListExecutionResults RPC.", "id": "ListExecutionResultsResponse", "properties": { "executionResults": { @@ -2876,11 +2813,11 @@ true "type": "object" }, "ListExecutionsResponse": { -"description": "Message for response to listing Executions", +"description": "Response message for the ListExecutions RPC.", "id": "ListExecutionsResponse", "properties": { "executions": { -"description": "The list of Execution", +"description": "The list of Execution.", "items": { "$ref": "Execution" }, @@ -2944,15 +2881,11 @@ true "type": "object" }, "ListRulesResponse": { -"description": "Mesesage of response of list rules", +"description": "Response message for the ListRules RPC.", "id": "ListRulesResponse", "properties": { -"invalidRulesWrapper": { -"$ref": "InvalidRulesWrapper", -"description": "A wrapper of the invalid rules that failed to be validated." -}, "rules": { -"description": "all rules in response", +"description": "All rules in response.", "items": { "$ref": "Rule" }, @@ -2962,7 +2895,7 @@ true "type": "object" }, "ListScannedResourcesResponse": { -"description": "Message for response to list scanned resources", +"description": "Response message for the ListScannedResources RPC.", "id": "ListScannedResourcesResponse", "properties": { "nextPageToken": { @@ -2970,7 +2903,7 @@ true "type": "string" }, "scannedResources": { -"description": "All scanned resources in response", +"description": "All scanned resources in response.", "items": { "$ref": "ScannedResource" }, @@ -3081,11 +3014,11 @@ true "type": "object" }, "Notice": { -"description": "Message for additional information generated by the execution", +"description": "Additional information generated by an execution.", "id": "Notice", "properties": { "message": { -"description": "Output only. Message of the notice", +"description": "Output only. Message of the notice.", "readOnly": true, "type": "string" } @@ -3237,7 +3170,7 @@ true "type": "object" }, "Resource": { -"description": "Message represent resource in execution result", +"description": "Resource in execution result.", "id": "Resource", "properties": { "name": { @@ -3256,29 +3189,29 @@ true "type": "object" }, "ResourceFilter": { -"description": "Message describing resource filters", +"description": "Resource filter for an evaluation defining the scope of resources to be evaluated.", "id": "ResourceFilter", "properties": { "gceInstanceFilter": { "$ref": "GceInstanceFilter", -"description": "Filter compute engine resource" +"description": "Filter compute engine resources." }, "inclusionLabels": { "additionalProperties": { "type": "string" }, -"description": "The label used for filter resource", +"description": "Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying `{ \"env\": \"prod\", \"database\": \"nosql\" }` will only include resources that have labels `env=prod` and `database=nosql`.", "type": "object" }, "resourceIdPatterns": { -"description": "The id pattern for filter resource", +"description": "The pattern to filter resources by their id For example, a pattern of \".*prod-cluster.*\" will match all resources that contain \"prod-cluster\" in their ID.", "items": { "type": "string" }, "type": "array" }, "scopes": { -"description": "The scopes of evaluation resource", +"description": "The scopes of evaluation resource. Format: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`", "items": { "type": "string" }, @@ -3288,19 +3221,11 @@ true "type": "object" }, "ResourceStatus": { -"description": "Message describing resource status", +"description": "The lifecycle status of an Evaluation resource.", "id": "ResourceStatus", "properties": { -"rulesNewerVersions": { -"deprecated": true, -"description": "Historical: Used before 2023-05-22 the new version of rule id if exists", -"items": { -"type": "string" -}, -"type": "array" -}, "state": { -"description": "State of the resource", +"description": "State of the Evaluation resource.", "enum": [ "STATE_UNSPECIFIED", "CREATING", @@ -3319,7 +3244,7 @@ true "type": "object" }, "Rule": { -"description": "Message represent a rule", +"description": "A rule to be evaluated.", "id": "Rule", "properties": { "assetType": { @@ -3327,31 +3252,31 @@ true "type": "string" }, "description": { -"description": "descrite rule in plain language", +"description": "Describe rule in plain language.", "type": "string" }, "displayName": { -"description": "the name display in UI", +"description": "The name display in UI.", "type": "string" }, "errorMessage": { -"description": "the message template for rule", +"description": "The message template for rule.", "type": "string" }, "name": { -"description": "rule name", +"description": "Rule name.", "type": "string" }, "primaryCategory": { -"description": "the primary category", +"description": "The primary category.", "type": "string" }, "remediation": { -"description": "the remediation for the rule", +"description": "The remediation for the rule.", "type": "string" }, "revisionId": { -"description": "Output only. the version of the rule", +"description": "Output only. The version of the rule.", "readOnly": true, "type": "string" }, @@ -3364,57 +3289,57 @@ true ], "enumDescriptions": [ "Not specified.", -"Baseline rules", -"Custom rules" +"Baseline rules.", +"Custom rules." ], "type": "string" }, "secondaryCategory": { -"description": "the secondary category", +"description": "The secondary category.", "type": "string" }, "severity": { -"description": "the severity of the rule", +"description": "The severity of the rule.", "type": "string" }, "tags": { -"description": "List of user-defined tags", +"description": "List of user-defined tags.", "items": { "type": "string" }, "type": "array" }, "uri": { -"description": "the docuement url for the rule", +"description": "The document url for the rule.", "type": "string" } }, "type": "object" }, "RuleExecutionResult": { -"description": "Message for execution result summary per rule", +"description": "Execution result summary per rule.", "id": "RuleExecutionResult", "properties": { "message": { -"description": "Execution message, if any", +"description": "Execution message, if any.", "type": "string" }, "resultCount": { -"description": "Number of violations", +"description": "Number of violations.", "format": "int64", "type": "string" }, "rule": { -"description": "rule name", +"description": "Rule name as plain text like `sap-hana-configured`.", "type": "string" }, "scannedResourceCount": { -"description": "Number of total scanned resources", +"description": "Number of total scanned resources.", "format": "int64", "type": "string" }, "state": { -"description": "Output only. The execution status", +"description": "Output only. The execution status.", "enum": [ "STATE_UNSPECIFIED", "STATE_SUCCESS", @@ -3423,9 +3348,9 @@ true ], "enumDescriptions": [ "Unknown state", -"execution completed successfully", -"execution completed with failures", -"execution was not executed" +"Execution completed successfully", +"Execution completed with failures", +"Execution was not executed" ], "readOnly": true, "type": "string" @@ -3454,15 +3379,15 @@ true "type": "object" }, "RunEvaluationRequest": { -"description": "Message for creating a Execution", +"description": "Request message for the RunEvaluation RPC.", "id": "RunEvaluationRequest", "properties": { "execution": { "$ref": "Execution", -"description": "Required. The resource being created" +"description": "Required. The resource being created." }, "executionId": { -"description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and execution_id from the method_signature of Create RPC", +"description": "Required. ID of the execution which will be created.", "type": "string" }, "requestId": { @@ -4310,15 +4235,15 @@ true "type": "object" }, "ScannedResource": { -"description": "Message of scanned resource", +"description": "A scanned resource.", "id": "ScannedResource", "properties": { "resource": { -"description": "resource name", +"description": "Resource name.", "type": "string" }, "type": { -"description": "resource type", +"description": "Resource type.", "type": "string" } }, @@ -4361,15 +4286,15 @@ true "type": "object" }, "ShellCommand": { -"description": "* A ShellCommand is invoked via the agent's command line executor", +"description": "A ShellCommand is invoked via the agent's command line executor.", "id": "ShellCommand", "properties": { "args": { -"description": "args is a string of arguments to be passed to the command.", +"description": "Arguments to be passed to the command.", "type": "string" }, "command": { -"description": "command is the name of the command to be executed.", +"description": "The name of the command to be executed.", "type": "string" }, "timeoutSeconds": { @@ -4714,23 +4639,23 @@ true "type": "object" }, "Summary": { -"description": "Message for execution summary", +"description": "Execution summary.", "id": "Summary", "properties": { "failures": { -"description": "Output only. Number of failures", +"description": "Output only. Number of failures.", "format": "int64", "readOnly": true, "type": "string" }, "newFailures": { -"description": "Output only. Number of new failures compared to the previous execution", +"description": "Output only. Number of new failures compared to the previous execution.", "format": "int64", "readOnly": true, "type": "string" }, "newFixes": { -"description": "Output only. Number of new fixes compared to the previous execution", +"description": "Output only. Number of new fixes compared to the previous execution.", "format": "int64", "readOnly": true, "type": "string" @@ -4821,7 +4746,7 @@ true "type": "object" }, "ViolationDetails": { -"description": "Message describing the violation in an evaluation result.", +"description": "The violation in an evaluation result.", "id": "ViolationDetails", "properties": { "asset": { From 3b6928a3b49fb303da7ce37ac01d00d92d74e3ca Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Mar 2026 07:29:47 +0000 Subject: [PATCH 31/31] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...r_v1.accessPolicies.servicePerimeters.html | 40 +- ...oidmanagement_v1.enterprises.policies.html | 12 +- docs/dyn/batch_v1.projects.locations.html | 4 +- ...min_v2.projects.instances.appProfiles.html | 10 +- docs/dyn/blogger_v3.blogs.html | 6 +- docs/dyn/chat_v1.spaces.messages.html | 32 +- docs/dyn/chat_v1.spaces.spaceEvents.html | 48 +- .../dyn/cloudtasks_v2.projects.locations.html | 8 +- ...oudtasks_v2.projects.locations.queues.html | 18 +- ...cloudtasks_v2beta2.projects.locations.html | 8 +- ...cloudtasks_v2beta3.projects.locations.html | 8 +- ...v1.accountTypes.accounts.partnerLinks.html | 2 +- ...Types.accounts.userListDirectLicenses.html | 2 +- ...Types.accounts.userListGlobalLicenses.html | 2 +- ...es.userListGlobalLicenseCustomerInfos.html | 2 +- ...er_v1.accountTypes.accounts.userLists.html | 2 +- docs/dyn/dfareporting_v5.placements.html | 7 +- .../dfareporting_v5.tvCampaignDetails.html | 1 + .../dfareporting_v5.tvCampaignSummaries.html | 1 + ...dlp_v2.organizations.inspectTemplates.html | 36 +- ...lp_v2.organizations.locations.dlpJobs.html | 12 +- ...tions.locations.fileStoreDataProfiles.html | 12 +- ...anizations.locations.inspectTemplates.html | 36 +- ...2.organizations.locations.jobTriggers.html | 36 +- ...nizations.locations.tableDataProfiles.html | 12 +- docs/dyn/dlp_v2.projects.content.html | 20 +- docs/dyn/dlp_v2.projects.dlpJobs.html | 42 +- docs/dyn/dlp_v2.projects.image.html | 8 +- .../dyn/dlp_v2.projects.inspectTemplates.html | 36 +- docs/dyn/dlp_v2.projects.jobTriggers.html | 48 +- .../dlp_v2.projects.locations.content.html | 20 +- .../dlp_v2.projects.locations.dlpJobs.html | 42 +- ...jects.locations.fileStoreDataProfiles.html | 12 +- docs/dyn/dlp_v2.projects.locations.image.html | 8 +- ...2.projects.locations.inspectTemplates.html | 36 +- ...dlp_v2.projects.locations.jobTriggers.html | 48 +- ....projects.locations.tableDataProfiles.html | 12 +- docs/dyn/docs_v1.documents.html | 196 ++--- ...v1.projects.locations.backends.builds.html | 12 +- ...ta.projects.locations.backends.builds.html | 12 +- ...ng_v1beta.projects.locations.backends.html | 8 +- .../kmsinventory_v1.projects.cryptoKeys.html | 4 +- ...nts_v1.accounts.developerRegistration.html | 2 +- ...erchantapi_accounts_v1.accounts.users.html | 4 +- ...erchantapi_accounts_v1.termsOfService.html | 2 +- ...v1beta.accounts.developerRegistration.html | 2 +- ...antapi_accounts_v1beta.accounts.users.html | 4 +- ...antapi_accounts_v1beta.termsOfService.html | 2 +- ...arametermanager_v1.projects.locations.html | 4 +- ...idding_v1.bidders.pretargetingConfigs.html | 786 +++++++++--------- docs/dyn/texttospeech_v1.text.html | 2 +- docs/dyn/texttospeech_v1beta1.text.html | 2 +- .../documents/accesscontextmanager.v1.json | 6 +- .../documents/androidmanagement.v1.json | 8 +- .../discovery_cache/documents/batch.v1.json | 4 +- .../documents/bigtableadmin.v2.json | 4 +- .../discovery_cache/documents/blogger.v3.json | 5 +- .../discovery_cache/documents/chat.v1.json | 6 +- .../documents/cloudtasks.v2.json | 8 +- .../documents/cloudtasks.v2beta2.json | 6 +- .../documents/cloudtasks.v2beta3.json | 6 +- .../documents/containeranalysis.v1.json | 14 +- .../documents/containeranalysis.v1alpha1.json | 14 +- .../documents/containeranalysis.v1beta1.json | 14 +- .../documents/datamanager.v1.json | 12 +- .../documents/datamigration.v1.json | 4 +- .../documents/dfareporting.v4.json | 4 +- .../documents/dfareporting.v5.json | 26 +- .../discovery_cache/documents/dlp.v2.json | 12 +- .../discovery_cache/documents/docs.v1.json | 6 +- .../documents/firebaseapphosting.v1.json | 4 +- .../documents/firebaseapphosting.v1beta.json | 4 +- .../documents/kmsinventory.v1.json | 8 +- .../documents/merchantapi.accounts_v1.json | 12 +- .../merchantapi.accounts_v1beta.json | 12 +- .../documents/parametermanager.v1.json | 4 +- .../documents/realtimebidding.v1.json | 52 +- .../documents/texttospeech.v1.json | 4 +- .../documents/texttospeech.v1beta1.json | 4 +- 79 files changed, 1020 insertions(+), 974 deletions(-) diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index 04cad02cbe..c4034a2160 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -173,7 +173,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -213,7 +213,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -266,7 +266,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -306,7 +306,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -446,7 +446,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -486,7 +486,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -539,7 +539,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -579,7 +579,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -661,7 +661,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -701,7 +701,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -754,7 +754,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -794,7 +794,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -882,7 +882,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -922,7 +922,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -975,7 +975,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1015,7 +1015,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1119,7 +1119,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1159,7 +1159,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1212,7 +1212,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1252,7 +1252,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index 5af5524096..9f7460aed3 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -422,7 +422,7 @@

Method Details

"mountPhysicalMediaDisabled": True or False, # Whether the user mounting physical external media is disabled. "name": "A String", # The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. "networkEscapeHatchEnabled": True or False, # Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.Note: Setting wifiConfigDisabled to true will override this setting under specific circumstances. Please see wifiConfigDisabled for further details. Setting configureWifi to DISALLOW_CONFIGURING_WIFI will override this setting under specific circumstances. Please see DISALLOW_CONFIGURING_WIFI for further details. - "networkResetDisabled": True or False, # Whether resetting network settings is disabled. + "networkResetDisabled": True or False, # Whether resetting network settings is disabled. This applies only on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. "oncCertificateProviders": [ # This feature is not generally available. { # This feature is not generally available. "certificateReferences": [ # This feature is not generally available. @@ -949,7 +949,7 @@

Method Details

"mountPhysicalMediaDisabled": True or False, # Whether the user mounting physical external media is disabled. "name": "A String", # The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. "networkEscapeHatchEnabled": True or False, # Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.Note: Setting wifiConfigDisabled to true will override this setting under specific circumstances. Please see wifiConfigDisabled for further details. Setting configureWifi to DISALLOW_CONFIGURING_WIFI will override this setting under specific circumstances. Please see DISALLOW_CONFIGURING_WIFI for further details. - "networkResetDisabled": True or False, # Whether resetting network settings is disabled. + "networkResetDisabled": True or False, # Whether resetting network settings is disabled. This applies only on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. "oncCertificateProviders": [ # This feature is not generally available. { # This feature is not generally available. "certificateReferences": [ # This feature is not generally available. @@ -1562,7 +1562,7 @@

Method Details

"mountPhysicalMediaDisabled": True or False, # Whether the user mounting physical external media is disabled. "name": "A String", # The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. "networkEscapeHatchEnabled": True or False, # Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.Note: Setting wifiConfigDisabled to true will override this setting under specific circumstances. Please see wifiConfigDisabled for further details. Setting configureWifi to DISALLOW_CONFIGURING_WIFI will override this setting under specific circumstances. Please see DISALLOW_CONFIGURING_WIFI for further details. - "networkResetDisabled": True or False, # Whether resetting network settings is disabled. + "networkResetDisabled": True or False, # Whether resetting network settings is disabled. This applies only on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. "oncCertificateProviders": [ # This feature is not generally available. { # This feature is not generally available. "certificateReferences": [ # This feature is not generally available. @@ -2080,7 +2080,7 @@

Method Details

"mountPhysicalMediaDisabled": True or False, # Whether the user mounting physical external media is disabled. "name": "A String", # The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. "networkEscapeHatchEnabled": True or False, # Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.Note: Setting wifiConfigDisabled to true will override this setting under specific circumstances. Please see wifiConfigDisabled for further details. Setting configureWifi to DISALLOW_CONFIGURING_WIFI will override this setting under specific circumstances. Please see DISALLOW_CONFIGURING_WIFI for further details. - "networkResetDisabled": True or False, # Whether resetting network settings is disabled. + "networkResetDisabled": True or False, # Whether resetting network settings is disabled. This applies only on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. "oncCertificateProviders": [ # This feature is not generally available. { # This feature is not generally available. "certificateReferences": [ # This feature is not generally available. @@ -2596,7 +2596,7 @@

Method Details

"mountPhysicalMediaDisabled": True or False, # Whether the user mounting physical external media is disabled. "name": "A String", # The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. "networkEscapeHatchEnabled": True or False, # Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.Note: Setting wifiConfigDisabled to true will override this setting under specific circumstances. Please see wifiConfigDisabled for further details. Setting configureWifi to DISALLOW_CONFIGURING_WIFI will override this setting under specific circumstances. Please see DISALLOW_CONFIGURING_WIFI for further details. - "networkResetDisabled": True or False, # Whether resetting network settings is disabled. + "networkResetDisabled": True or False, # Whether resetting network settings is disabled. This applies only on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. "oncCertificateProviders": [ # This feature is not generally available. { # This feature is not generally available. "certificateReferences": [ # This feature is not generally available. @@ -3128,7 +3128,7 @@

Method Details

"mountPhysicalMediaDisabled": True or False, # Whether the user mounting physical external media is disabled. "name": "A String", # The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. "networkEscapeHatchEnabled": True or False, # Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.Note: Setting wifiConfigDisabled to true will override this setting under specific circumstances. Please see wifiConfigDisabled for further details. Setting configureWifi to DISALLOW_CONFIGURING_WIFI will override this setting under specific circumstances. Please see DISALLOW_CONFIGURING_WIFI for further details. - "networkResetDisabled": True or False, # Whether resetting network settings is disabled. + "networkResetDisabled": True or False, # Whether resetting network settings is disabled. This applies only on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. "oncCertificateProviders": [ # This feature is not generally available. { # This feature is not generally available. "certificateReferences": [ # This feature is not generally available. diff --git a/docs/dyn/batch_v1.projects.locations.html b/docs/dyn/batch_v1.projects.locations.html index a7db5fe6cc..2353cff8a0 100644 --- a/docs/dyn/batch_v1.projects.locations.html +++ b/docs/dyn/batch_v1.projects.locations.html @@ -97,7 +97,7 @@

Instance Methods

Gets information about a location.

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

-

Lists information about the supported locations for this service.

+

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.

@@ -136,7 +136,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/bigtableadmin_v2.projects.instances.appProfiles.html b/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
index 9d37754e37..702e9653d1 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
@@ -115,7 +115,7 @@ 

Method Details

"computeBillingOwner": "A String", # The Compute Billing Owner for this Data Boost App Profile. }, "description": "A String", # Long form description of the use case for this AppProfile. - "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. + "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the meantime. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy. "clusterIds": [ # The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. "A String", @@ -149,7 +149,7 @@

Method Details

"computeBillingOwner": "A String", # The Compute Billing Owner for this Data Boost App Profile. }, "description": "A String", # Long form description of the use case for this AppProfile. - "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. + "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the meantime. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy. "clusterIds": [ # The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. "A String", @@ -207,7 +207,7 @@

Method Details

"computeBillingOwner": "A String", # The Compute Billing Owner for this Data Boost App Profile. }, "description": "A String", # Long form description of the use case for this AppProfile. - "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. + "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the meantime. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy. "clusterIds": [ # The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. "A String", @@ -250,7 +250,7 @@

Method Details

"computeBillingOwner": "A String", # The Compute Billing Owner for this Data Boost App Profile. }, "description": "A String", # Long form description of the use case for this AppProfile. - "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. + "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the meantime. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy. "clusterIds": [ # The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. "A String", @@ -304,7 +304,7 @@

Method Details

"computeBillingOwner": "A String", # The Compute Billing Owner for this Data Boost App Profile. }, "description": "A String", # Long form description of the use case for this AppProfile. - "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. + "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the meantime. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy. "clusterIds": [ # The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. "A String", diff --git a/docs/dyn/blogger_v3.blogs.html b/docs/dyn/blogger_v3.blogs.html index 887750a9dd..2652132339 100644 --- a/docs/dyn/blogger_v3.blogs.html +++ b/docs/dyn/blogger_v3.blogs.html @@ -99,7 +99,7 @@

Method Details

Args: blogId: string, A parameter (required) maxPosts: integer, A parameter - view: string, A parameter + view: string, Unspecified is interpreted as READER. Allowed values VIEW_TYPE_UNSPECIFIED - READER - @@ -221,7 +221,7 @@

Method Details

Args: url: string, A parameter (required) - view: string, A parameter + view: string, Unspecified is interpreted as READER. Allowed values VIEW_TYPE_UNSPECIFIED - READER - @@ -354,7 +354,7 @@

Method Details

Allowed values LIVE - DELETED - - view: string, A parameter + view: string, Unspecified is interpreted as the user's role on the blog. Allowed values VIEW_TYPE_UNSPECIFIED - READER - diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 73def8d2dd..ba1a8bc433 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -2105,8 +2105,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -5141,8 +5141,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -8195,8 +8195,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -11237,8 +11237,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -14284,8 +14284,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -17314,8 +17314,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -20344,8 +20344,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -23374,8 +23374,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 00891b0f1b..cf1cdc4c43 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -2220,8 +2220,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -5245,8 +5245,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -8270,8 +8270,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -11293,8 +11293,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -14314,8 +14314,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -17335,8 +17335,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -20773,8 +20773,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -23798,8 +23798,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -26823,8 +26823,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -29846,8 +29846,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -32867,8 +32867,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): @@ -35888,8 +35888,8 @@

Method Details

], }, ], - "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) - { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder) + "cardsV2": [ # Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) + { # A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder) "card": { # A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. Any widgets beyond this limit are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ``` # A card. Maximum size is 32 KB. "cardActions": [ # The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): diff --git a/docs/dyn/cloudtasks_v2.projects.locations.html b/docs/dyn/cloudtasks_v2.projects.locations.html index 867d2bd08e..e2d835eaeb 100644 --- a/docs/dyn/cloudtasks_v2.projects.locations.html +++ b/docs/dyn/cloudtasks_v2.projects.locations.html @@ -90,13 +90,13 @@

Instance Methods

Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.

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.

updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)

-

Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.

+

Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.

Method Details

close() @@ -152,7 +152,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)
@@ -202,7 +202,7 @@ 

Method Details

updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None) -
Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
+  
Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
 
 Args:
   name: string, Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
index c816570f1d..aca4be3c13 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
@@ -174,7 +174,7 @@ 

Method Details

"name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "purgeTime": "A String", # Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. "rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. + "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, @@ -240,7 +240,7 @@

Method Details

"name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "purgeTime": "A String", # Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. "rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. + "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, @@ -331,7 +331,7 @@

Method Details

"name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "purgeTime": "A String", # Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. "rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. + "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, @@ -453,7 +453,7 @@

Method Details

"name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "purgeTime": "A String", # Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. "rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. + "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, @@ -537,7 +537,7 @@

Method Details

"name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "purgeTime": "A String", # Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. "rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. + "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, @@ -604,7 +604,7 @@

Method Details

"name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "purgeTime": "A String", # Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. "rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. + "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, @@ -683,7 +683,7 @@

Method Details

"name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "purgeTime": "A String", # Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. "rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. + "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, @@ -762,7 +762,7 @@

Method Details

"name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "purgeTime": "A String", # Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. "rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. + "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, @@ -841,7 +841,7 @@

Method Details

"name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "purgeTime": "A String", # Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. "rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. + "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.html index 649b08f31f..7fcfb1eb19 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.html +++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.html @@ -90,13 +90,13 @@

Instance Methods

Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.

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.

updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)

-

Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.

+

Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.

Method Details

close() @@ -152,7 +152,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)
@@ -202,7 +202,7 @@ 

Method Details

updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None) -
Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
+  
Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
 
 Args:
   name: string, Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.html
index 8f967e35a6..470d79a842 100644
--- a/docs/dyn/cloudtasks_v2beta3.projects.locations.html
+++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.html
@@ -90,13 +90,13 @@ 

Instance Methods

Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.

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.

updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)

-

Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.

+

Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.

Method Details

close() @@ -152,7 +152,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)
@@ -202,7 +202,7 @@ 

Method Details

updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None) -
Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
+  
Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
 
 Args:
   name: string, Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html
index 9e28ded300..bb3d635b57 100644
--- a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html
+++ b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html
@@ -167,7 +167,7 @@ 

Method Details

Args: parent: string, Required. Account to search for partner links. If no `filter` is specified, all partner links where this account is either the `owning_account` or `partner_account` are returned. Format: `accountTypes/{account_type}/accounts/{account}` (required) - filter: string, Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321` + filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321` pageSize: integer, The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100. pageToken: string, A page token, received from a previous `SearchPartnerLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPartnerLinks` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html index 08cd5168d1..2fb0be417d 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html @@ -260,7 +260,7 @@

Method Details

Args: parent: string, Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required) - filter: string, Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` + filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` pageSize: integer, Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html index 9dfc358377..6420db3fee 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html @@ -259,7 +259,7 @@

Method Details

Args: parent: string, Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required) - filter: string, Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` + filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` pageSize: integer, Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, Optional. A page token, received from a previous `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html index 7c4e873ff5..1e3ff953fe 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html @@ -95,7 +95,7 @@

Method Details

Args: parent: string, Required. The global license whose customer info are being queried. Should be in the format `accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}`. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, `accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-`) (required) - filter: string, Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` + filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` pageSize: integer, Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html index 7f42e2ba39..5c2fa069a2 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html @@ -322,7 +322,7 @@

Method Details

Args: parent: string, Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account} (required) - filter: string, Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = "list 1"`). Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types` + filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = "list 1"`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types` pageSize: integer, Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, Optional. A page token, received from a previous `ListUserLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLists` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/dfareporting_v5.placements.html b/docs/dyn/dfareporting_v5.placements.html index 266cf221af..08330a9fee 100644 --- a/docs/dyn/dfareporting_v5.placements.html +++ b/docs/dyn/dfareporting_v5.placements.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, x__xgafv=None)

+ generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, tagProperties_dcDbmMacroIncluded=None, tagProperties_gppMacrosIncluded=None, tagProperties_tcfGdprMacrosIncluded=None, x__xgafv=None)

Generates tags for a placement.

get(profileId, id, x__xgafv=None)

@@ -105,7 +105,7 @@

Method Details

- generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, x__xgafv=None) + generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, tagProperties_dcDbmMacroIncluded=None, tagProperties_gppMacrosIncluded=None, tagProperties_tcfGdprMacrosIncluded=None, x__xgafv=None)
Generates tags for a placement.
 
 Args:
@@ -134,6 +134,9 @@ 

Method Details

PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY - PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4 - PLACEMENT_TAG_TRACKING_THIRD_PARTY_MEASUREMENT - + tagProperties_dcDbmMacroIncluded: boolean, Optional. Indicates whether to include the dc_dbm macro in the generated tags. [Learn more](https://support.google.com/campaignmanager/answer/9280273) about this macro. + tagProperties_gppMacrosIncluded: boolean, Optional. Indicates whether to include the GPP macro in the generated tags. [Learn more](https://support.google.com/campaignmanager/answer/10031693) about this macro. + tagProperties_tcfGdprMacrosIncluded: boolean, Optional. Indicates whether to include the TCF macro in the generated tags. Default true. [Learn more](https://support.google.com/campaignmanager/answer/10031693) about this macro. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dfareporting_v5.tvCampaignDetails.html b/docs/dyn/dfareporting_v5.tvCampaignDetails.html index 4f1914f3e7..6cd7425a3f 100644 --- a/docs/dyn/dfareporting_v5.tvCampaignDetails.html +++ b/docs/dyn/dfareporting_v5.tvCampaignDetails.html @@ -98,6 +98,7 @@

Method Details

tvDataProvider: string, Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`. Allowed values INVALID_TV_DATA_PROVIDER - + INTAGE_JP - IBOPE_AR - IBOPE_BR - IBOPE_CL - diff --git a/docs/dyn/dfareporting_v5.tvCampaignSummaries.html b/docs/dyn/dfareporting_v5.tvCampaignSummaries.html index d9e27ea9fa..c795f0eb6a 100644 --- a/docs/dyn/dfareporting_v5.tvCampaignSummaries.html +++ b/docs/dyn/dfareporting_v5.tvCampaignSummaries.html @@ -98,6 +98,7 @@

Method Details

tvDataProvider: string, Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`. Allowed values INVALID_TV_DATA_PROVIDER - + INTAGE_JP - IBOPE_AR - IBOPE_BR - IBOPE_CL - diff --git a/docs/dyn/dlp_v2.organizations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.inspectTemplates.html index e76c605d76..4719a6916a 100644 --- a/docs/dyn/dlp_v2.organizations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.inspectTemplates.html @@ -121,7 +121,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -151,7 +151,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -160,7 +160,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -380,7 +380,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -410,7 +410,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -419,7 +419,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -661,7 +661,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -691,7 +691,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -700,7 +700,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -930,7 +930,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -960,7 +960,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -969,7 +969,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1206,7 +1206,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1236,7 +1236,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1245,7 +1245,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1464,7 +1464,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1494,7 +1494,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1503,7 +1503,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index ab507c23e9..84f3b9fd1e 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -2791,7 +2791,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -2821,7 +2821,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -2830,7 +2830,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -3118,7 +3118,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -3148,7 +3148,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -3157,7 +3157,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index ea7d146f1c..43a5ff2a98 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -553,7 +553,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -583,7 +583,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -592,7 +592,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1388,7 +1388,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1418,7 +1418,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1427,7 +1427,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html index a7a951f66a..fdc2b8c263 100644 --- a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html @@ -121,7 +121,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -151,7 +151,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -160,7 +160,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -380,7 +380,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -410,7 +410,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -419,7 +419,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -661,7 +661,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -691,7 +691,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -700,7 +700,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -930,7 +930,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -960,7 +960,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -969,7 +969,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1206,7 +1206,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1236,7 +1236,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1245,7 +1245,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1464,7 +1464,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1494,7 +1494,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1503,7 +1503,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html index 84071d56a4..1ee45c3875 100644 --- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html @@ -187,7 +187,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -217,7 +217,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -226,7 +226,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -606,7 +606,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -636,7 +636,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -645,7 +645,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1047,7 +1047,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1077,7 +1077,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1086,7 +1086,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1482,7 +1482,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1512,7 +1512,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1521,7 +1521,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1918,7 +1918,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1948,7 +1948,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1957,7 +1957,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -2336,7 +2336,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -2366,7 +2366,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -2375,7 +2375,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index 5423a1c0ec..f59b553b1a 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -553,7 +553,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -583,7 +583,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -592,7 +592,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1332,7 +1332,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1362,7 +1362,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1371,7 +1371,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html index 84471b9ae2..93525289fc 100644 --- a/docs/dyn/dlp_v2.projects.content.html +++ b/docs/dyn/dlp_v2.projects.content.html @@ -964,7 +964,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -994,7 +994,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1003,7 +1003,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -2135,7 +2135,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -2165,7 +2165,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -2174,7 +2174,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -2477,7 +2477,7 @@

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'. + "key": "A String", # The metadata key. The format depends on the source of the metadata. Example: - `MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled` (a Microsoft Purview Information Protection key example) }, "storageLabel": { # Storage metadata label to indicate which metadata entry contains findings. # Storage metadata. "key": "A String", # Label name. @@ -2569,7 +2569,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -2599,7 +2599,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -2608,7 +2608,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index 0f8b2f38f1..3c40623ffb 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -190,7 +190,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -220,7 +220,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -229,7 +229,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -3364,7 +3364,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -3394,7 +3394,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -3403,7 +3403,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -3691,7 +3691,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -3721,7 +3721,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -3730,7 +3730,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -7225,7 +7225,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -7255,7 +7255,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -7264,7 +7264,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -7552,7 +7552,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -7582,7 +7582,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -7591,7 +7591,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -11080,7 +11080,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -11110,7 +11110,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -11119,7 +11119,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -11407,7 +11407,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -11437,7 +11437,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -11446,7 +11446,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.image.html b/docs/dyn/dlp_v2.projects.image.html index 8727622f0d..a51951e574 100644 --- a/docs/dyn/dlp_v2.projects.image.html +++ b/docs/dyn/dlp_v2.projects.image.html @@ -125,7 +125,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -155,7 +155,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -164,7 +164,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -429,7 +429,7 @@

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'. + "key": "A String", # The metadata key. The format depends on the source of the metadata. Example: - `MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled` (a Microsoft Purview Information Protection key example) }, "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 d46c9dae1c..99bbef60c0 100644 --- a/docs/dyn/dlp_v2.projects.inspectTemplates.html +++ b/docs/dyn/dlp_v2.projects.inspectTemplates.html @@ -121,7 +121,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -151,7 +151,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -160,7 +160,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -380,7 +380,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -410,7 +410,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -419,7 +419,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -661,7 +661,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -691,7 +691,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -700,7 +700,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -930,7 +930,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -960,7 +960,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -969,7 +969,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1206,7 +1206,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1236,7 +1236,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1245,7 +1245,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1464,7 +1464,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1494,7 +1494,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1503,7 +1503,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index 6f11573b93..03ebb9b217 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -2795,7 +2795,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -2825,7 +2825,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -2834,7 +2834,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -3122,7 +3122,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -3152,7 +3152,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -3161,7 +3161,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -4039,7 +4039,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -4069,7 +4069,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -4078,7 +4078,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -4458,7 +4458,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -4488,7 +4488,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -4497,7 +4497,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -4899,7 +4899,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -4929,7 +4929,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -4938,7 +4938,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -5334,7 +5334,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -5364,7 +5364,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -5373,7 +5373,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -5770,7 +5770,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -5800,7 +5800,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -5809,7 +5809,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -6188,7 +6188,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -6218,7 +6218,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -6227,7 +6227,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html index 8926a3b708..ae011a8705 100644 --- a/docs/dyn/dlp_v2.projects.locations.content.html +++ b/docs/dyn/dlp_v2.projects.locations.content.html @@ -964,7 +964,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -994,7 +994,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1003,7 +1003,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -2135,7 +2135,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -2165,7 +2165,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -2174,7 +2174,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -2477,7 +2477,7 @@

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'. + "key": "A String", # The metadata key. The format depends on the source of the metadata. Example: - `MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled` (a Microsoft Purview Information Protection key example) }, "storageLabel": { # Storage metadata label to indicate which metadata entry contains findings. # Storage metadata. "key": "A String", # Label name. @@ -2569,7 +2569,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -2599,7 +2599,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -2608,7 +2608,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index 1e121255f9..f6b9734f40 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -196,7 +196,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -226,7 +226,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -235,7 +235,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -3370,7 +3370,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -3400,7 +3400,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -3409,7 +3409,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -3697,7 +3697,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -3727,7 +3727,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -3736,7 +3736,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -7255,7 +7255,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -7285,7 +7285,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -7294,7 +7294,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -7582,7 +7582,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -7612,7 +7612,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -7621,7 +7621,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -11198,7 +11198,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -11228,7 +11228,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -11237,7 +11237,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -11525,7 +11525,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -11555,7 +11555,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -11564,7 +11564,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 92e9bfd475..a1eced22f7 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -553,7 +553,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -583,7 +583,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -592,7 +592,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1388,7 +1388,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1418,7 +1418,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1427,7 +1427,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.locations.image.html b/docs/dyn/dlp_v2.projects.locations.image.html index 21e1985673..982305be15 100644 --- a/docs/dyn/dlp_v2.projects.locations.image.html +++ b/docs/dyn/dlp_v2.projects.locations.image.html @@ -125,7 +125,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -155,7 +155,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -164,7 +164,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -429,7 +429,7 @@

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'. + "key": "A String", # The metadata key. The format depends on the source of the metadata. Example: - `MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled` (a Microsoft Purview Information Protection key example) }, "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 dc951236f9..b0590c71cf 100644 --- a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html @@ -121,7 +121,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -151,7 +151,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -160,7 +160,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -380,7 +380,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -410,7 +410,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -419,7 +419,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -661,7 +661,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -691,7 +691,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -700,7 +700,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -930,7 +930,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -960,7 +960,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -969,7 +969,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1206,7 +1206,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1236,7 +1236,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1245,7 +1245,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1464,7 +1464,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1494,7 +1494,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1503,7 +1503,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index 0fa2b29ffb..93ff477875 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -2798,7 +2798,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -2828,7 +2828,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -2837,7 +2837,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -3125,7 +3125,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -3155,7 +3155,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -3164,7 +3164,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -4042,7 +4042,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -4072,7 +4072,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -4081,7 +4081,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -4461,7 +4461,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -4491,7 +4491,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -4500,7 +4500,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -4902,7 +4902,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -4932,7 +4932,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -4941,7 +4941,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -5425,7 +5425,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -5455,7 +5455,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -5464,7 +5464,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -5861,7 +5861,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -5891,7 +5891,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -5900,7 +5900,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -6279,7 +6279,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -6309,7 +6309,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -6318,7 +6318,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index 37d5f227ee..b54cde2300 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -553,7 +553,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -583,7 +583,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -592,7 +592,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, @@ -1332,7 +1332,7 @@

Method Details

], "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType. + "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. @@ -1362,7 +1362,7 @@

Method Details

], }, }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType. + "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. @@ -1371,7 +1371,7 @@

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. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair 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. }, diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index 493bbf5a28..44ca91c4bb 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -218,9 +218,9 @@

Method Details

}, "insertDate": { # Inserts a date at the specified location. # Inserts a date. "dateElementProperties": { # Properties of a DateElement. # The properties of the date to insert. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -1294,9 +1294,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -1305,9 +1305,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -3449,9 +3449,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -3460,9 +3460,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -5544,9 +5544,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -5555,9 +5555,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -7639,9 +7639,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -7650,9 +7650,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -10913,9 +10913,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -10924,9 +10924,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -13067,9 +13067,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -13078,9 +13078,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -15162,9 +15162,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -15173,9 +15173,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -17257,9 +17257,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -17268,9 +17268,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -20546,9 +20546,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -20557,9 +20557,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -22701,9 +22701,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -22712,9 +22712,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -24796,9 +24796,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -24807,9 +24807,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -26891,9 +26891,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -26902,9 +26902,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -30165,9 +30165,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -30176,9 +30176,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -32319,9 +32319,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -32330,9 +32330,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -34414,9 +34414,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -34425,9 +34425,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -36509,9 +36509,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -36520,9 +36520,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -39812,9 +39812,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -39823,9 +39823,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -41967,9 +41967,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -41978,9 +41978,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -44062,9 +44062,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -44073,9 +44073,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -46157,9 +46157,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -46168,9 +46168,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -49431,9 +49431,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -49442,9 +49442,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -51585,9 +51585,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -51596,9 +51596,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -53680,9 +53680,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -53691,9 +53691,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -55775,9 +55775,9 @@

Method Details

}, "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. @@ -55786,9 +55786,9 @@

Method Details

"suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. "a_key": { # A suggested change to a DateElementProperties. "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. diff --git a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html index 3c81f7f49b..f1f3e783d0 100644 --- a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html +++ b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html @@ -122,7 +122,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error @@ -134,7 +134,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). @@ -306,7 +306,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error @@ -318,7 +318,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). @@ -428,7 +428,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error @@ -440,7 +440,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html index 535e1cd753..3981c9c591 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html @@ -122,7 +122,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error @@ -134,7 +134,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). @@ -316,7 +316,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error @@ -328,7 +328,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). @@ -448,7 +448,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error @@ -460,7 +460,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html index 56ee358902..e1aeba1802 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html @@ -165,7 +165,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. @@ -297,7 +297,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. @@ -366,7 +366,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. @@ -443,7 +443,7 @@

Method Details

"originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. - "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + "variable": "A String", # Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with "X_FIREBASE_". }, ], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. diff --git a/docs/dyn/kmsinventory_v1.projects.cryptoKeys.html b/docs/dyn/kmsinventory_v1.projects.cryptoKeys.html index 24aa71fbf9..c062f1cc88 100644 --- a/docs/dyn/kmsinventory_v1.projects.cryptoKeys.html +++ b/docs/dyn/kmsinventory_v1.projects.cryptoKeys.html @@ -112,8 +112,8 @@

Method Details

"cryptoKeyBackend": "A String", # Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format `projects/*/locations/*/ekmConnections/*`. Only applicable if CryptoKeyVersions have a ProtectionLevel of HSM_SINGLE_TENANT, with the resource name in the format `projects/*/locations/*/singleTenantHsmInstances/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. "destroyScheduledDuration": "A String", # Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 30 days. "importOnly": True or False, # Immutable. Whether this key may contain imported versions only. - "keyAccessJustificationsPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey. # Optional. The policy used for Key Access Justifications Policy Enforcement. If this field is present and this key is enrolled in Key Access Justifications Policy Enforcement, the policy will be evaluated in encrypt, decrypt, and sign operations, and the operation will fail if rejected by the policy. The policy is defined by specifying zero or more allowed justification codes. https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes By default, this field is absent, and all justification codes are allowed. - "allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail. + "keyAccessJustificationsPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy). # Optional. The policy used for Key Access Justifications Policy Enforcement. If this field is present and this key is enrolled in Key Access Justifications Policy Enforcement, the policy will be evaluated in encrypt, decrypt, and sign operations, and the operation will fail if rejected by the policy. The policy is defined by specifying zero or more allowed justification codes. https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes By default, this field is absent, and all justification codes are allowed. If the `key_access_justifications_policy.allowed_access_reasons` is empty (zero allowed justification code), all encrypt, decrypt, and sign operations will fail. + "allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all. "A String", ], }, diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html b/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html index fc5818eb78..6fc729e756 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html @@ -145,7 +145,7 @@

Method Details

The object takes the form of: { # Request message for the RegisterGCP method. - "developerEmail": "A String", # Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have "API developer" access type and the email preference corresponding to that user will be updated to have the new "API notifications" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new "API notifications" preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can't receive emails. + "developerEmail": "A String", # Immutable. Optional field. Developer role can be also added by using `users.update` method. If the developer email provided is associated with a user in the provided merchant account, the user will be updated to have `API_DEVELOPER` `access_rights` and the email preference corresponding to that user will be updated to have the new API notifications preference. If the developer email provided is not associated with any user, it is added as a contact. The email preference corresponding to that contact will have the new API notifications preference. Make sure the email used is associated with a Google Account and is not a service account as service accounts can't receive emails. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.users.html b/docs/dyn/merchantapi_accounts_v1.accounts.users.html index b7d9fe5d4e..d6bc3cbd74 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.users.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.users.html @@ -87,7 +87,7 @@

Instance Methods

Creates a Merchant Center account user. Executing this method requires admin access.

delete(name, x__xgafv=None)

-

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"

+

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account.

get(name, x__xgafv=None)

Retrieves a Merchant Center account user.

@@ -143,7 +143,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"
+  
Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account.
 
 Args:
   name: string, Required. The name of the user to delete. Format: `accounts/{account}/users/{email}` It is also possible to delete the user corresponding to the caller by using `me` rather than an email address as in `accounts/{account}/users/me`. (required)
diff --git a/docs/dyn/merchantapi_accounts_v1.termsOfService.html b/docs/dyn/merchantapi_accounts_v1.termsOfService.html
index a52fe3ed0c..ba5a650535 100644
--- a/docs/dyn/merchantapi_accounts_v1.termsOfService.html
+++ b/docs/dyn/merchantapi_accounts_v1.termsOfService.html
@@ -161,7 +161,7 @@ 

Method Details

kind: string, Required. The Kind this terms of service version applies to. Allowed values TERMS_OF_SERVICE_KIND_UNSPECIFIED - Default value. This value is unused. - MERCHANT_CENTER - Merchant Center application. + MERCHANT_CENTER - Terms of service for the Merchant Center application. regionCode: string, Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html index 794c2f822d..4c91ff2719 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html @@ -145,7 +145,7 @@

Method Details

The object takes the form of: { # Request message for the RegisterGCP method. - "developerEmail": "A String", # Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have "API developer" access type and the email preference corresponding to that user will be updated to have the new "API notifications" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new "API notifications" preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can't receive emails. + "developerEmail": "A String", # Immutable. Optional field. Developer role can be also added by using `users.update` method. If the developer email provided is associated with a user in the provided merchant account, the user will be updated to have `API_DEVELOPER` `access_rights` and the email preference corresponding to that user will be updated to have the new API notifications preference. If the developer email provided is not associated with any user, it is added as a contact. The email preference corresponding to that contact will have the new API notifications preference. Make sure the email used is associated with a Google Account and is not a service account as service accounts can't receive emails. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html index ebfa0bb2d2..77d3c0a9ab 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html @@ -87,7 +87,7 @@

Instance Methods

Creates a Merchant Center account user. Executing this method requires admin access.

delete(name, x__xgafv=None)

-

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"

+

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account.

get(name, x__xgafv=None)

Retrieves a Merchant Center account user.

@@ -143,7 +143,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"
+  
Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account.
 
 Args:
   name: string, Required. The name of the user to delete. Format: `accounts/{account}/users/{email}` It is also possible to delete the user corresponding to the caller by using `me` rather than an email address as in `accounts/{account}/users/me`. (required)
diff --git a/docs/dyn/merchantapi_accounts_v1beta.termsOfService.html b/docs/dyn/merchantapi_accounts_v1beta.termsOfService.html
index 6cf76de8b0..11043332cb 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.termsOfService.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.termsOfService.html
@@ -161,7 +161,7 @@ 

Method Details

kind: string, Required. The Kind this terms of service version applies to. Allowed values TERMS_OF_SERVICE_KIND_UNSPECIFIED - Default value. This value is unused. - MERCHANT_CENTER - Merchant Center application. + MERCHANT_CENTER - Terms of service for the Merchant Center application. regionCode: string, Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/parametermanager_v1.projects.locations.html b/docs/dyn/parametermanager_v1.projects.locations.html index 246e35cbc3..ccab0a993f 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.html +++ b/docs/dyn/parametermanager_v1.projects.locations.html @@ -87,7 +87,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.

@@ -126,7 +126,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/realtimebidding_v1.bidders.pretargetingConfigs.html b/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html
index 6a14f3b8bd..fb7cd037e5 100644
--- a/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html
+++ b/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html
@@ -140,16 +140,16 @@ 

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -160,20 +160,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -182,52 +182,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -260,16 +260,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -280,20 +280,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -302,52 +302,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -380,16 +380,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -400,20 +400,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -422,52 +422,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -500,16 +500,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -520,20 +520,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -542,52 +542,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -610,16 +610,16 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. +{ # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -630,20 +630,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -652,52 +652,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -713,16 +713,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -733,20 +733,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -755,52 +755,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -841,16 +841,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -861,20 +861,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -883,52 +883,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -956,16 +956,16 @@

Method Details

{ # A response containing pretargeting configurations. "nextPageToken": "A String", # A token which can be passed to a subsequent call to the `ListPretargetingConfigs` method to retrieve the next page of results in ListPretargetingConfigsRequest.pageToken. "pretargetingConfigs": [ # List of pretargeting configurations. - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -976,20 +976,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -998,52 +998,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -1073,20 +1073,20 @@

Method Details

Updates a pretargeting configuration.
 
 Args:
-  name: string, Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` (required)
+  name: string, Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
-  "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
+{ # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
+  "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
     "A String",
   ],
   "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
     "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
-      "excludedIds": [ # The IDs excluded in a configuration.
+      "excludedIds": [ # The IDs excluded in a config.
         "A String",
       ],
-      "includedIds": [ # The IDs included in a configuration.
+      "includedIds": [ # The IDs included in a config.
         "A String",
       ],
     },
@@ -1097,20 +1097,20 @@ 

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -1119,52 +1119,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -1181,16 +1181,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -1201,20 +1201,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -1223,52 +1223,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -1300,16 +1300,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -1320,20 +1320,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -1342,52 +1342,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -1419,16 +1419,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -1439,20 +1439,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -1461,52 +1461,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -1538,16 +1538,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -1558,20 +1558,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -1580,52 +1580,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", @@ -1654,16 +1654,16 @@

Method Details

Returns: An object of the form: - { # Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. - "allowedUserTargetingModes": [ # Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. + { # Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for. + "allowedUserTargetingModes": [ # Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. "A String", ], "appTargeting": { # A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. # Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). "mobileAppCategoryTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv. - "excludedIds": [ # The IDs excluded in a configuration. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, @@ -1674,20 +1674,20 @@

Method Details

], }, }, - "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. - "displayName": "A String", # The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. - "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + "billingId": "A String", # Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. + "displayName": "A String", # The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. + "excludedContentLabelIds": [ # The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. "A String", ], - "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv - "excludedIds": [ # The IDs excluded in a configuration. + "geoTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "includedCreativeDimensions": [ # Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. + "includedCreativeDimensions": [ # Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. { # The dimensions of a creative. This applies to only HTML and Native creatives. "height": "A String", # The height of the creative in pixels. "width": "A String", # The width of the creative in pixels. @@ -1696,52 +1696,52 @@

Method Details

"includedEnvironments": [ # Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. "A String", ], - "includedFormats": [ # Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. + "includedFormats": [ # Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. "A String", ], - "includedLanguages": [ # The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. + "includedLanguages": [ # The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. "A String", ], - "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + "includedMobileOperatingSystemIds": [ # The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv "A String", ], - "includedPlatforms": [ # The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. + "includedPlatforms": [ # The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. "A String", ], - "includedUserIdTypes": [ # User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. + "includedUserIdTypes": [ # User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. "A String", ], - "interstitialTargeting": "A String", # The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. + "interstitialTargeting": "A String", # The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. "invalidGeoIds": [ # Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. "A String", ], - "maximumQps": "A String", # The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. - "name": "A String", # Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` + "maximumQps": "A String", # The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide + "minimumViewabilityDecile": 42, # The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. + "name": "A String", # Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` "publisherTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered. "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", ], }, - "state": "A String", # Output only. The state of this pretargeting configuration. - "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this configuration as defined in UserList. - "excludedIds": [ # The IDs excluded in a configuration. + "state": "A String", # Output only. The state of this pretargeting config. + "userListTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The remarketing lists included or excluded in this config as defined in UserList. + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals - "excludedIds": [ # The IDs excluded in a configuration. + "verticalTargeting": { # Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. # The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + "excludedIds": [ # The IDs excluded in a config. "A String", ], - "includedIds": [ # The IDs included in a configuration. + "includedIds": [ # The IDs included in a config. "A String", ], }, - "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration). + "webTargeting": { # Generic targeting with string values used in app, website and publisher targeting. # Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). "targetingMode": "A String", # How the items in this list should be targeted. "values": [ # The values specified. "A String", diff --git a/docs/dyn/texttospeech_v1.text.html b/docs/dyn/texttospeech_v1.text.html index 98e2853e51..c9c56c8fe4 100644 --- a/docs/dyn/texttospeech_v1.text.html +++ b/docs/dyn/texttospeech_v1.text.html @@ -98,7 +98,7 @@

Method Details

"advancedVoiceOptions": { # Used for advanced voice options. # Optional. Advanced voice options. "enableTextnorm": True or False, # Optional. If true, textnorm will be applied to text input. This feature is enabled by default. Only applies for Gemini TTS. "lowLatencyJourneySynthesis": True or False, # Only for Journey voices. If false, the synthesis is context aware and has a higher latency. - "relaxSafetyFilters": True or False, # Optional. Input only. If true, relaxes safety filters for Gemini TTS. Only supported for accounts linked to Invoiced (Offline) Cloud billing accounts. Otherwise, will return result google.rpc.Code.INVALID_ARGUMENT. + "relaxSafetyFilters": True or False, # Optional. Input only. If true, relaxes safety filters for Gemini TTS. }, "audioConfig": { # Description of audio data to be synthesized. # Required. The configuration of the synthesized audio. "audioEncoding": "A String", # Required. The format of the audio byte stream. diff --git a/docs/dyn/texttospeech_v1beta1.text.html b/docs/dyn/texttospeech_v1beta1.text.html index e723829800..d79bef975b 100644 --- a/docs/dyn/texttospeech_v1beta1.text.html +++ b/docs/dyn/texttospeech_v1beta1.text.html @@ -98,7 +98,7 @@

Method Details

"advancedVoiceOptions": { # Used for advanced voice options. # Optional. Advanced voice options. "enableTextnorm": True or False, # Optional. If true, textnorm will be applied to text input. This feature is enabled by default. Only applies for Gemini TTS. "lowLatencyJourneySynthesis": True or False, # Only for Journey voices. If false, the synthesis is context aware and has a higher latency. - "relaxSafetyFilters": True or False, # Optional. Input only. If true, relaxes safety filters for Gemini TTS. Only supported for accounts linked to Invoiced (Offline) Cloud billing accounts. Otherwise, will return result google.rpc.Code.INVALID_ARGUMENT. + "relaxSafetyFilters": True or False, # Optional. Input only. If true, relaxes safety filters for Gemini TTS. }, "audioConfig": { # Description of audio data to be synthesized. # Required. The configuration of the synthesized audio. "audioEncoding": "A String", # Required. The format of the audio byte stream. diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 8afef4ab5a..d8d162c828 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1331,7 +1331,7 @@ } } }, -"revision": "20260215", +"revision": "20260311", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1786,7 +1786,7 @@ "id": "EgressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", +"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, @@ -2011,7 +2011,7 @@ "id": "IngressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", +"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For the list of supported identity types, see https://docs.cloud.google.com/vpc-service-controls/docs/supported-identities.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 5724a1fd75..cbc7cbb5fa 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1265,7 +1265,7 @@ } } }, -"revision": "20260303", +"revision": "20260312", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2196,7 +2196,7 @@ false "The app is blocked and can't be installed. If the app was installed under a previous policy, it will be uninstalled. This also blocks its instant app functionality.", "The app is available to install.", "The app is automatically installed and can't be removed by the user and will prevent setup from completion until installation is complete.", -"The app is automatically installed in kiosk mode: it's set as the preferred home intent and whitelisted for lock task mode. Device setup won't complete until the app is installed. After installation, users won't be able to remove the app. You can only set this installType for one app per policy. When this is present in the policy, status bar will be automatically disabled.If there is any app with KIOSK role, then this install type cannot be set for any app.", +"The app is automatically installed in kiosk mode: it's set as the preferred home intent and whitelisted for lock task mode. Device setup won't complete until the app is installed. After installation, users won't be able to remove the app. You can only set this installType for one app per policy. When this is present in the policy, status bar will be automatically disabled.On Android 11 and above, when an app has this install type, the user control is disallowed for all apps. The IT admin can set userControlSettings to USER_CONTROL_ALLOWED to allow user control for specific apps.If there is any app with KIOSK role, then this install type cannot be set for any app.", "The app can only be installed and updated via AMAPI SDK command (https://developers.google.com/android/management/extensibility-sdk-integration).Note: This only affects fully managed devices. Play related fields minimumVersionCode, accessibleTrackIds, autoUpdateMode, installConstraint and installPriority cannot be set for the app. The app isn't available in the Play Store. The app installed on the device has applicationSource set to CUSTOM. When the current installType is CUSTOM, the signing key certificate fingerprint of the existing custom app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts . Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported. Changing the installType from CUSTOM to another value must match the playstore version of the application signing key certificate fingerprint. Otherwise a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported. Changing the installType to CUSTOM uninstalls the existing app if its signing key certificate fingerprint of the installed app doesn't match the one from the ApplicationPolicy.signingKeyCerts . Removing the app from applications doesn't uninstall the existing app if it conforms to playStoreMode. See also customAppConfig. This is different from the Google Play Custom App Publishing (https://developers.google.com/android/work/play/custom-app-api/get-started) feature." ], "type": "string" @@ -6436,7 +6436,7 @@ false "type": "boolean" }, "networkResetDisabled": { -"description": "Whether resetting network settings is disabled.", +"description": "Whether resetting network settings is disabled. This applies only on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported for other management modes.", "type": "boolean" }, "oncCertificateProviders": { @@ -7133,7 +7133,7 @@ false "enumDescriptions": [ "The role type is unspecified. This value must not be used.", "The role type for companion apps. This role enables the app as a companion app with the capability of interacting with Android Device Policy offline. This is the recommended way to configure an app as a companion app. For legacy way, see extensionConfig.On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed for the app with this role. userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with this role.Android Device Policy notifies the companion app of any local command status updates if the app has a service with . See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details on the requirements for the service.", -"The role type for kiosk apps. An app can have this role only if it has installType set to REQUIRED_FOR_SETUP or CUSTOM. Before adding this role to an app with CUSTOM install type, the app must already be installed on the device.The app having this role type is set as the preferred home intent and allowlisted for lock task mode. When there is an app with this role type, status bar will be automatically disabled.This is preferable to setting installType to KIOSK.On Android 11 and above, the user control is disallowed but userControlSettings can be set to USER_CONTROL_ALLOWED to allow user control for the app with this role.", +"The role type for kiosk apps. An app can have this role only if it has installType set to REQUIRED_FOR_SETUP or CUSTOM. Before adding this role to an app with CUSTOM install type, the app must already be installed on the device.The app having this role type is set as the preferred home intent and allowlisted for lock task mode. When there is an app with this role type, status bar will be automatically disabled.This is preferable to setting installType to KIOSK.On Android 11 and above, when an app has this role, the user control is disallowed for all apps. The IT admin can set userControlSettings to USER_CONTROL_ALLOWED to allow user control for specific apps.", "The role type for Mobile Threat Defense (MTD) / Endpoint Detection & Response (EDR) apps.On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed and userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with this role.", "The role type for system health monitoring apps.On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed and userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with this role." ], diff --git a/googleapiclient/discovery_cache/documents/batch.v1.json b/googleapiclient/discovery_cache/documents/batch.v1.json index 126a6cd20f..c23f96969c 100644 --- a/googleapiclient/discovery_cache/documents/batch.v1.json +++ b/googleapiclient/discovery_cache/documents/batch.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": "batch.projects.locations.list", @@ -600,7 +600,7 @@ } } }, -"revision": "20251112", +"revision": "20260302", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 537d402680..9eac0dddc8 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -3118,7 +3118,7 @@ } } }, -"revision": "20260225", +"revision": "20260307", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3134,7 +3134,7 @@ "type": "string" }, "etag": { -"description": "Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.", +"description": "Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the meantime. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.", "type": "string" }, "multiClusterRoutingUseAny": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v3.json b/googleapiclient/discovery_cache/documents/blogger.v3.json index fd09633bb2..4f444b01ed 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -169,6 +169,7 @@ "type": "integer" }, "view": { +"description": "Unspecified is interpreted as READER.", "enum": [ "VIEW_TYPE_UNSPECIFIED", "READER", @@ -209,6 +210,7 @@ "type": "string" }, "view": { +"description": "Unspecified is interpreted as READER.", "enum": [ "VIEW_TYPE_UNSPECIFIED", "READER", @@ -285,6 +287,7 @@ "type": "string" }, "view": { +"description": "Unspecified is interpreted as the user's role on the blog.", "enum": [ "VIEW_TYPE_UNSPECIFIED", "READER", @@ -1710,7 +1713,7 @@ } } }, -"revision": "20250524", +"revision": "20260309", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index b9b8f756f1..9a13918fc0 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1535,7 +1535,7 @@ } } }, -"revision": "20260205", +"revision": "20260305", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1950,7 +1950,7 @@ "type": "object" }, "CardWithId": { -"description": "A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the message can't contain cards. [Card builder](https://addons.gsuite.google.com/uikit/builder)", +"description": "A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)", "id": "CardWithId", "properties": { "card": { @@ -4693,7 +4693,7 @@ "type": "array" }, "cardsV2": { -"description": "Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)", +"description": "Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)", "items": { "$ref": "CardWithId" }, diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json index 5005dd28e6..fe54c8bdcf 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json @@ -160,7 +160,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": "v2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "cloudtasks.projects.locations.list", @@ -207,7 +207,7 @@ ] }, "updateCmekConfig": { -"description": "Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.", +"description": "Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/cmekConfig", "httpMethod": "PATCH", "id": "cloudtasks.projects.locations.updateCmekConfig", @@ -785,7 +785,7 @@ } } }, -"revision": "20251021", +"revision": "20260306", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { @@ -1416,7 +1416,7 @@ "id": "RateLimits", "properties": { "maxBurstSize": { -"description": "Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. ", +"description": "Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. ", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json index 55330c06a3..a9a02b551e 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json @@ -192,7 +192,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": "v2beta2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "cloudtasks.projects.locations.list", @@ -239,7 +239,7 @@ ] }, "updateCmekConfig": { -"description": "Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.", +"description": "Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.", "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/cmekConfig", "httpMethod": "PATCH", "id": "cloudtasks.projects.locations.updateCmekConfig", @@ -941,7 +941,7 @@ } } }, -"revision": "20251021", +"revision": "20260306", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json index 2dfad75f6e..ecb99093a1 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json @@ -160,7 +160,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": "v2beta3/projects/{projectsId}/locations", "httpMethod": "GET", "id": "cloudtasks.projects.locations.list", @@ -207,7 +207,7 @@ ] }, "updateCmekConfig": { -"description": "Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.", +"description": "Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.", "flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/cmekConfig", "httpMethod": "PATCH", "id": "cloudtasks.projects.locations.updateCmekConfig", @@ -797,7 +797,7 @@ } } }, -"revision": "20260115", +"revision": "20260306", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index 15364965e9..ebdab7ae70 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -1715,7 +1715,7 @@ } } }, -"revision": "20260220", +"revision": "20260305", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -3438,14 +3438,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" }, @@ -3831,14 +3833,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/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index c28d2275eb..7e7ccd8d9e 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -1452,7 +1452,7 @@ } } }, -"revision": "20260220", +"revision": "20260305", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -2982,14 +2982,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" }, @@ -3375,14 +3377,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/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index 977e5cb3c5..75f4b90ee9 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -1771,7 +1771,7 @@ } } }, -"revision": "20260220", +"revision": "20260305", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -3360,14 +3360,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" }, @@ -3753,14 +3755,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/datamanager.v1.json b/googleapiclient/discovery_cache/documents/datamanager.v1.json index ea64b99878..f1afc4e42d 100644 --- a/googleapiclient/discovery_cache/documents/datamanager.v1.json +++ b/googleapiclient/discovery_cache/documents/datamanager.v1.json @@ -206,7 +206,7 @@ ], "parameters": { "filter": { -"description": "Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = \"GOOGLE_ADS\" AND partner_account.account_id = 987654321`", +"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = \"GOOGLE_ADS\" AND partner_account.account_id = 987654321`", "location": "query", "type": "string" }, @@ -304,7 +304,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`", +"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`", "location": "query", "type": "string" }, @@ -436,7 +436,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`", +"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`", "location": "query", "type": "string" }, @@ -515,7 +515,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`", +"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`", "location": "query", "type": "string" }, @@ -650,7 +650,7 @@ ], "parameters": { "filter": { -"description": "Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = \"list 1\"`). Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types`", +"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = \"list 1\"`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types`", "location": "query", "type": "string" }, @@ -814,7 +814,7 @@ } } }, -"revision": "20260228", +"revision": "20260307", "rootUrl": "https://datamanager.googleapis.com/", "schemas": { "AdIdentifiers": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 8720fb0015..445810d629 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2587,7 +2587,7 @@ } } }, -"revision": "20260225", +"revision": "20260304", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -7293,7 +7293,7 @@ "Unspecified.", "Only 'ca_certificate' specified.", "Both server ('ca_certificate'), and client ('client_key', 'client_certificate') specified.", -"Mandates SSL encryption for all connections. This doesn\u2019t require certificate verification.", +"Mandates SSL encryption for all connections. This does not require certificate verification.", "Connection is not encrypted." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v4.json b/googleapiclient/discovery_cache/documents/dfareporting.v4.json index 3ad6643d91..e51b9c5d89 100644 --- a/googleapiclient/discovery_cache/documents/dfareporting.v4.json +++ b/googleapiclient/discovery_cache/documents/dfareporting.v4.json @@ -10465,7 +10465,7 @@ } } }, -"revision": "20260213", +"revision": "20260310", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -22484,6 +22484,7 @@ "description": "The date window of the timepoint.", "enum": [ "WEEKS_UNSPECIFIED", +"DAYS_ONE", "WEEKS_ONE", "WEEKS_FOUR", "WEEKS_EIGHT", @@ -22491,6 +22492,7 @@ ], "enumDescriptions": [ "Default value, should never be set.", +"One Day.", "One week.", "Four weeks.", "Eight weeks.", diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v5.json b/googleapiclient/discovery_cache/documents/dfareporting.v5.json index 1e4e98994e..0d010dbf6e 100644 --- a/googleapiclient/discovery_cache/documents/dfareporting.v5.json +++ b/googleapiclient/discovery_cache/documents/dfareporting.v5.json @@ -7110,6 +7110,22 @@ "location": "query", "repeated": true, "type": "string" +}, +"tagProperties.dcDbmMacroIncluded": { +"description": "Optional. Indicates whether to include the dc_dbm macro in the generated tags. [Learn more](https://support.google.com/campaignmanager/answer/9280273) about this macro.", +"location": "query", +"type": "boolean" +}, +"tagProperties.gppMacrosIncluded": { +"description": "Optional. Indicates whether to include the GPP macro in the generated tags. [Learn more](https://support.google.com/campaignmanager/answer/10031693) about this macro.", +"location": "query", +"type": "boolean" +}, +"tagProperties.tcfGdprMacrosIncluded": { +"default": "true", +"description": "Optional. Indicates whether to include the TCF macro in the generated tags. Default true. [Learn more](https://support.google.com/campaignmanager/answer/10031693) about this macro.", +"location": "query", +"type": "boolean" } }, "path": "userprofiles/{+profileId}/placements/generatetags", @@ -9457,6 +9473,7 @@ "description": "Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`.", "enum": [ "INVALID_TV_DATA_PROVIDER", +"INTAGE_JP", "IBOPE_AR", "IBOPE_BR", "IBOPE_CL", @@ -9475,6 +9492,7 @@ "", "", "", +"", "" ], "location": "query", @@ -9531,6 +9549,7 @@ "description": "Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`.", "enum": [ "INVALID_TV_DATA_PROVIDER", +"INTAGE_JP", "IBOPE_AR", "IBOPE_BR", "IBOPE_CL", @@ -9549,6 +9568,7 @@ "", "", "", +"", "" ], "location": "query", @@ -10071,7 +10091,7 @@ } } }, -"revision": "20260213", +"revision": "20260310", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -12463,6 +12483,7 @@ "items": { "enum": [ "INVALID_TV_DATA_PROVIDER", +"INTAGE_JP", "IBOPE_AR", "IBOPE_BR", "IBOPE_CL", @@ -12481,6 +12502,7 @@ "", "", "", +"", "" ], "type": "string" @@ -21451,6 +21473,7 @@ "description": "The date window of the timepoint.", "enum": [ "WEEKS_UNSPECIFIED", +"DAYS_ONE", "WEEKS_ONE", "WEEKS_FOUR", "WEEKS_EIGHT", @@ -21458,6 +21481,7 @@ ], "enumDescriptions": [ "Default value, should never be set.", +"One Day.", "One week.", "Four weeks.", "Eight weeks.", diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 3ff17dcd81..b56115ff79 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5128,7 +5128,7 @@ } } }, -"revision": "20260228", +"revision": "20260307", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -6793,7 +6793,7 @@ "id": "GooglePrivacyDlpV2CustomInfoType", "properties": { "detectionRules": { -"description": "Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType.", +"description": "Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes.", "items": { "$ref": "GooglePrivacyDlpV2DetectionRule" }, @@ -6804,7 +6804,7 @@ "description": "A list of phrases to detect as a CustomInfoType." }, "exclusionType": { -"description": "If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType.", +"description": "If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes.", "enum": [ "EXCLUSION_TYPE_UNSPECIFIED", "EXCLUSION_TYPE_EXCLUDE" @@ -6841,7 +6841,7 @@ }, "metadataKeyValueExpression": { "$ref": "GooglePrivacyDlpV2MetadataKeyValueExpression", -"description": "key-value pairs to detect in the metadata." +"description": "Key-value pair to detect in the metadata." }, "regex": { "$ref": "GooglePrivacyDlpV2Regex", @@ -10320,7 +10320,7 @@ "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'.", +"description": "The metadata key. The format depends on the source of the metadata. Example: - `MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled` (a Microsoft Purview Information Protection key example)", "type": "string" } }, @@ -10792,7 +10792,7 @@ "type": "object" }, "GooglePrivacyDlpV2MetadataKeyValueExpression": { -"description": "Configuration for a custom infoType that detects given expression of key-value pair in the metadata.", +"description": "Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions.", "id": "GooglePrivacyDlpV2MetadataKeyValueExpression", "properties": { "keyRegex": { diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 7c8e79de06..0dafa87179 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -221,7 +221,7 @@ } } }, -"revision": "20260114", +"revision": "20260309", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AddDocumentTabRequest": { @@ -748,7 +748,7 @@ "id": "DateElementProperties", "properties": { "dateFormat": { -"description": "Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent.", +"description": "Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent.", "enum": [ "DATE_FORMAT_UNSPECIFIED", "DATE_FORMAT_CUSTOM", @@ -772,7 +772,7 @@ "type": "string" }, "locale": { -"description": "The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`.", +"description": "The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`.", "type": "string" }, "timeFormat": { diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json index 099d13c571..250133fc2b 100644 --- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json @@ -1106,7 +1106,7 @@ } } }, -"revision": "20260219", +"revision": "20260305", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2018,7 +2018,7 @@ "type": "string" }, "variable": { -"description": "Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with \"FIREBASE\" or \"GOOGLE\". - May not be a reserved environment variable for KNative/Cloud Run", +"description": "Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with \"X_FIREBASE_\".", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json index 3332fedbe6..65c76403de 100644 --- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json @@ -1103,7 +1103,7 @@ } } }, -"revision": "20260219", +"revision": "20260305", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2044,7 +2044,7 @@ "type": "string" }, "variable": { -"description": "Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with \"FIREBASE\" or \"GOOGLE\". - May not be a reserved environment variable for KNative/Cloud Run", +"description": "Required. The name of the environment variable. The environment variables reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/services/environment-variables#reserved) should not be set. Additionally, variable names cannot start with \"X_FIREBASE_\".", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json index b261addff9..c3b089785f 100644 --- a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json +++ b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json @@ -306,7 +306,7 @@ } } }, -"revision": "20260216", +"revision": "20260308", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { @@ -504,7 +504,7 @@ }, "keyAccessJustificationsPolicy": { "$ref": "GoogleCloudKmsV1KeyAccessJustificationsPolicy", -"description": "Optional. The policy used for Key Access Justifications Policy Enforcement. If this field is present and this key is enrolled in Key Access Justifications Policy Enforcement, the policy will be evaluated in encrypt, decrypt, and sign operations, and the operation will fail if rejected by the policy. The policy is defined by specifying zero or more allowed justification codes. https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes By default, this field is absent, and all justification codes are allowed." +"description": "Optional. The policy used for Key Access Justifications Policy Enforcement. If this field is present and this key is enrolled in Key Access Justifications Policy Enforcement, the policy will be evaluated in encrypt, decrypt, and sign operations, and the operation will fail if rejected by the policy. The policy is defined by specifying zero or more allowed justification codes. https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes By default, this field is absent, and all justification codes are allowed. If the `key_access_justifications_policy.allowed_access_reasons` is empty (zero allowed justification code), all encrypt, decrypt, and sign operations will fail." }, "labels": { "additionalProperties": { @@ -937,11 +937,11 @@ "type": "object" }, "GoogleCloudKmsV1KeyAccessJustificationsPolicy": { -"description": "A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey.", +"description": "A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy).", "id": "GoogleCloudKmsV1KeyAccessJustificationsPolicy", "properties": { "allowedAccessReasons": { -"description": "The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail.", +"description": "The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all.", "items": { "enum": [ "REASON_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json index 8410653dc8..89ec07af81 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json @@ -2154,7 +2154,7 @@ ] }, "delete": { -"description": "Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager\"", +"description": "Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account.", "flatPath": "accounts/v1/accounts/{accountsId}/users/{usersId}", "httpMethod": "DELETE", "id": "merchantapi.accounts.users.delete", @@ -2388,7 +2388,7 @@ ], "enumDescriptions": [ "Default value. This value is unused.", -"Merchant Center application." +"Terms of service for the Merchant Center application." ], "location": "query", "type": "string" @@ -2410,7 +2410,7 @@ } } }, -"revision": "20260223", +"revision": "20260310", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -5056,7 +5056,7 @@ false "id": "RegisterGcpRequest", "properties": { "developerEmail": { -"description": "Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have \"API developer\" access type and the email preference corresponding to that user will be updated to have the new \"API notifications\" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new \"API notifications\" preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can't receive emails.", +"description": "Immutable. Optional field. Developer role can be also added by using `users.update` method. If the developer email provided is associated with a user in the provided merchant account, the user will be updated to have `API_DEVELOPER` `access_rights` and the email preference corresponding to that user will be updated to have the new API notifications preference. If the developer email provided is not associated with any user, it is added as a contact. The email preference corresponding to that contact will have the new API notifications preference. Make sure the email used is associated with a Google Account and is not a service account as service accounts can't receive emails.", "type": "string" } }, @@ -5438,7 +5438,7 @@ false ], "enumDescriptions": [ "Default value. This value is unused.", -"Merchant Center application." +"Terms of service for the Merchant Center application." ], "type": "string" }, @@ -5481,7 +5481,7 @@ false ], "enumDescriptions": [ "Default value. This value is unused.", -"Merchant Center application." +"Terms of service for the Merchant Center application." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index ab46ba444c..e0b7631800 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -2104,7 +2104,7 @@ ] }, "delete": { -"description": "Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager\"", +"description": "Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account.", "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}", "httpMethod": "DELETE", "id": "merchantapi.accounts.users.delete", @@ -2338,7 +2338,7 @@ ], "enumDescriptions": [ "Default value. This value is unused.", -"Merchant Center application." +"Terms of service for the Merchant Center application." ], "location": "query", "type": "string" @@ -2360,7 +2360,7 @@ } } }, -"revision": "20260223", +"revision": "20260310", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -4933,7 +4933,7 @@ false "id": "RegisterGcpRequest", "properties": { "developerEmail": { -"description": "Immutable. If the developer email provided is associated with a user in the merchant account provided, the user will be updated to have \"API developer\" access type and the email preference corresponding to that user will be updated to have the new \"API notifications\" preference. If the developer email provided is not associated with any user we will just add it as a contact. The email preference corresponding to that contact will have the new \"API notifications\" preference. Make sure the email used is associated with a Google Account (Google Workspace account or Gmail account) and is not a service account as service accounts can't receive emails.", +"description": "Immutable. Optional field. Developer role can be also added by using `users.update` method. If the developer email provided is associated with a user in the provided merchant account, the user will be updated to have `API_DEVELOPER` `access_rights` and the email preference corresponding to that user will be updated to have the new API notifications preference. If the developer email provided is not associated with any user, it is added as a contact. The email preference corresponding to that contact will have the new API notifications preference. Make sure the email used is associated with a Google Account and is not a service account as service accounts can't receive emails.", "type": "string" } }, @@ -5315,7 +5315,7 @@ false ], "enumDescriptions": [ "Default value. This value is unused.", -"Merchant Center application." +"Terms of service for the Merchant Center application." ], "type": "string" }, @@ -5358,7 +5358,7 @@ false ], "enumDescriptions": [ "Default value. This value is unused.", -"Merchant Center application." +"Terms of service for the Merchant Center application." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json index a828a021ee..d63d0c1349 100644 --- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json +++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json @@ -382,7 +382,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": "parametermanager.projects.locations.list", @@ -841,7 +841,7 @@ } } }, -"revision": "20260107", +"revision": "20260309", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index aa564010e3..c4904674ef 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -586,7 +586,7 @@ ], "parameters": { "name": { -"description": "Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`", +"description": "Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`", "location": "path", "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", "required": true, @@ -1305,7 +1305,7 @@ } } }, -"revision": "20260114", +"revision": "20260311", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -2677,7 +2677,7 @@ false "id": "NumericTargetingDimension", "properties": { "excludedIds": { -"description": "The IDs excluded in a configuration.", +"description": "The IDs excluded in a config.", "items": { "format": "int64", "type": "string" @@ -2685,7 +2685,7 @@ false "type": "array" }, "includedIds": { -"description": "The IDs included in a configuration.", +"description": "The IDs included in a config.", "items": { "format": "int64", "type": "string" @@ -2795,11 +2795,11 @@ false "type": "object" }, "PretargetingConfig": { -"description": "Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.", +"description": "Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.", "id": "PretargetingConfig", "properties": { "allowedUserTargetingModes": { -"description": "Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.", +"description": "Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.", "items": { "enum": [ "USER_TARGETING_MODE_UNSPECIFIED", @@ -2820,17 +2820,17 @@ false "description": "Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension)." }, "billingId": { -"description": "Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.", +"description": "Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids.", "format": "int64", "readOnly": true, "type": "string" }, "displayName": { -"description": "The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.", +"description": "The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has.", "type": "string" }, "excludedContentLabelIds": { -"description": "The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.", +"description": "The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.", "items": { "format": "int64", "type": "string" @@ -2839,10 +2839,10 @@ false }, "geoTargeting": { "$ref": "NumericTargetingDimension", -"description": "The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv" +"description": "The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv" }, "includedCreativeDimensions": { -"description": "Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.", +"description": "Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.", "items": { "$ref": "CreativeDimensions" }, @@ -2866,7 +2866,7 @@ false "type": "array" }, "includedFormats": { -"description": "Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.", +"description": "Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.", "items": { "enum": [ "CREATIVE_FORMAT_UNSPECIFIED", @@ -2885,14 +2885,14 @@ false "type": "array" }, "includedLanguages": { -"description": "The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.", +"description": "The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.", "items": { "type": "string" }, "type": "array" }, "includedMobileOperatingSystemIds": { -"description": "The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv", +"description": "The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv", "items": { "format": "int64", "type": "string" @@ -2900,7 +2900,7 @@ false "type": "array" }, "includedPlatforms": { -"description": "The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.", +"description": "The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.", "items": { "enum": [ "PLATFORM_UNSPECIFIED", @@ -2921,7 +2921,7 @@ false "type": "array" }, "includedUserIdTypes": { -"description": "User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.", +"description": "User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent.", "items": { "enum": [ "USER_ID_TYPE_UNSPECIFIED", @@ -2944,7 +2944,7 @@ false "type": "array" }, "interstitialTargeting": { -"description": "The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.", +"description": "The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.", "enum": [ "INTERSTITIAL_TARGETING_UNSPECIFIED", "ONLY_INTERSTITIAL_REQUESTS", @@ -2967,17 +2967,17 @@ false "type": "array" }, "maximumQps": { -"description": "The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide", +"description": "The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide", "format": "int64", "type": "string" }, "minimumViewabilityDecile": { -"description": "The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.", +"description": "The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.", "format": "int32", "type": "integer" }, "name": { -"description": "Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`", +"description": "Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`", "readOnly": true, "type": "string" }, @@ -2986,7 +2986,7 @@ false "description": "Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in the order that they were entered." }, "state": { -"description": "Output only. The state of this pretargeting configuration.", +"description": "Output only. The state of this pretargeting config.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -2994,23 +2994,23 @@ false ], "enumDescriptions": [ "Placeholder for undefined state.", -"This pretargeting configuration is actively being used to filter bid requests.", -"This pretargeting configuration is suspended and not used in serving." +"This pretargeting config is actively being used to filter bid requests.", +"This pretargeting config is suspended and not used in serving." ], "readOnly": true, "type": "string" }, "userListTargeting": { "$ref": "NumericTargetingDimension", -"description": "The remarketing lists included or excluded in this configuration as defined in UserList." +"description": "The remarketing lists included or excluded in this config as defined in UserList." }, "verticalTargeting": { "$ref": "NumericTargetingDimension", -"description": "The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals" +"description": "The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals" }, "webTargeting": { "$ref": "StringTargetingDimension", -"description": "Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration)." +"description": "Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config)." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index 29345aac96..eadbf9ac7d 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -323,7 +323,7 @@ } } }, -"revision": "20260123", +"revision": "20260312", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -339,7 +339,7 @@ "type": "boolean" }, "relaxSafetyFilters": { -"description": "Optional. Input only. If true, relaxes safety filters for Gemini TTS. Only supported for accounts linked to Invoiced (Offline) Cloud billing accounts. Otherwise, will return result google.rpc.Code.INVALID_ARGUMENT.", +"description": "Optional. Input only. If true, relaxes safety filters for Gemini TTS.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json index 3874d24184..b3a341739c 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -266,7 +266,7 @@ } } }, -"revision": "20260123", +"revision": "20260312", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -282,7 +282,7 @@ "type": "boolean" }, "relaxSafetyFilters": { -"description": "Optional. Input only. If true, relaxes safety filters for Gemini TTS. Only supported for accounts linked to Invoiced (Offline) Cloud billing accounts. Otherwise, will return result google.rpc.Code.INVALID_ARGUMENT.", +"description": "Optional. Input only. If true, relaxes safety filters for Gemini TTS.", "type": "boolean" } },