From 68293004a1f80604f5eda2f4ec3f3ffbadfa2e96 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:08 +0000 Subject: [PATCH 01/27] chore: update docs/dyn/index.md --- docs/dyn/index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 929ad9ac558..e25dfecbacb 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -225,7 +225,6 @@ ## blogger -* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/blogger_v2.html) * [v3](http://googleapis.github.io/google-api-python-client/docs/dyn/blogger_v3.html) @@ -295,6 +294,10 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudchannel_v1.html) +## cloudcommerceprocurement +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudcommerceprocurement_v1.html) + + ## cloudcontrolspartner * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudcontrolspartner_v1.html) * [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudcontrolspartner_v1beta.html) @@ -325,6 +328,7 @@ ## cloudlocationfinder +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudlocationfinder_v1.html) * [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/cloudlocationfinder_v1alpha.html) From e8eefdc62fb7bf1f8b70e6c670afa014208b5421 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:08 +0000 Subject: [PATCH 02/27] feat(aiplatform): update the api #### aiplatform:v1 The following keys were added: - resources.projects.resources.locations.methods.generateSyntheticData (Total Keys: 12) - resources.projects.resources.locations.resources.evaluationItems.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.evaluationItems.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationItems.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationItems.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.evaluationRuns.methods.cancel (Total Keys: 12) - resources.projects.resources.locations.resources.evaluationRuns.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.evaluationRuns.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationRuns.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationRuns.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.evaluationSets.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.evaluationSets.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationSets.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationSets.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.evaluationSets.methods.patch (Total Keys: 15) - schemas.GoogleCloudAiplatformV1BigQueryRequestSet (Total Keys: 15) - schemas.GoogleCloudAiplatformV1CancelEvaluationRunRequest (Total Keys: 2) - schemas.GoogleCloudAiplatformV1CandidateResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1CandidateResult (Total Keys: 10) - schemas.GoogleCloudAiplatformV1EvaluationItem (Total Keys: 17) - schemas.GoogleCloudAiplatformV1EvaluationPrompt (Total Keys: 9) - schemas.GoogleCloudAiplatformV1EvaluationRequest (Total Keys: 8) - schemas.GoogleCloudAiplatformV1EvaluationResult (Total Keys: 13) - schemas.GoogleCloudAiplatformV1EvaluationRubricConfig (Total Keys: 5) - schemas.GoogleCloudAiplatformV1EvaluationRun (Total Keys: 101) - schemas.GoogleCloudAiplatformV1EvaluationSet (Total Keys: 13) - schemas.GoogleCloudAiplatformV1GenerateSyntheticDataRequest (Total Keys: 8) - schemas.GoogleCloudAiplatformV1GenerateSyntheticDataResponse (Total Keys: 4) - schemas.GoogleCloudAiplatformV1ListEvaluationItemsResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1ListEvaluationRunsResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1ListEvaluationSetsResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1MetricResult.properties.error (Total Keys: 2) - schemas.GoogleCloudAiplatformV1MetricResult.properties.explanation.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1MetricResult.properties.rubricVerdicts.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1MetricResult.properties.score.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1OutputFieldSpec (Total Keys: 5) - schemas.GoogleCloudAiplatformV1ReasoningEngine.properties.labels (Total Keys: 2) - schemas.GoogleCloudAiplatformV1SummaryMetrics (Total Keys: 8) - schemas.GoogleCloudAiplatformV1SyntheticExample (Total Keys: 4) - schemas.GoogleCloudAiplatformV1SyntheticField (Total Keys: 4) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironment.properties.metadata (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecCodeExecutionEnvironment.properties.dependencies (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecCodeExecutionEnvironment.properties.env (Total Keys: 2) The following keys were added: - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.list.parameters.orderBy (Total Keys: 2) - resources.reasoningEngines.resources.memories.methods.list.parameters.orderBy (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1DeployedModel.properties.disableContainerLogging.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1MetricResult.properties.error (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1MetricResult.properties.explanation.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1MetricResult.properties.rubricVerdicts.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1MetricResult.properties.score.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec.properties.exportLastCheckpointOnly.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngine.properties.labels (Total Keys: 2) --- ...v1.projects.locations.evaluationItems.html | 1095 ++++++ ..._v1.projects.locations.evaluationRuns.html | 3218 +++++++++++++++++ ..._v1.projects.locations.evaluationSets.html | 295 ++ .../dyn/aiplatform_v1.projects.locations.html | 176 +- ...1.projects.locations.reasoningEngines.html | 12 + docs/dyn/aiplatform_v1.reasoningEngines.html | 12 + ...cts.locations.deploymentResourcePools.html | 1 + ..._v1beta1.projects.locations.endpoints.html | 8 + ...aiplatform_v1beta1.projects.locations.html | 15 +- ...1.projects.locations.reasoningEngines.html | 12 + ...s.locations.reasoningEngines.memories.html | 15 +- ....reasoningEngines.sandboxEnvironments.html | 30 - ...v1beta1.projects.locations.tuningJobs.html | 5 + .../aiplatform_v1beta1.reasoningEngines.html | 12 + ...orm_v1beta1.reasoningEngines.memories.html | 15 +- .../documents/aiplatform.v1.json | 1448 +++++++- .../documents/aiplatform.v1beta1.json | 72 +- 17 files changed, 6357 insertions(+), 84 deletions(-) create mode 100644 docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html new file mode 100644 index 00000000000..537b43aa2f6 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -0,0 +1,1095 @@ + + + +

Vertex AI API . projects . locations . evaluationItems

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an Evaluation Item.

+

+ delete(name, x__xgafv=None)

+

Deletes an Evaluation Item.

+

+ get(name, x__xgafv=None)

+

Gets an Evaluation Item.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Evaluation Items.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an Evaluation Item.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed.
+  "createTime": "A String", # Output only. Timestamp when this item was created.
+  "displayName": "A String", # Required. The display name of the EvaluationItem.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error for the evaluation item.
+    "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.
+  },
+  "evaluationItemType": "A String", # Required. The type of the EvaluationItem.
+  "evaluationRequest": { # Single evaluation request. # The request to evaluate.
+    "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+      { # Responses from model or agent.
+        "candidate": "A String", # Required. The name of the candidate that produced the response.
+        "text": "A String", # Text response.
+        "value": "", # Fields and values that can be used to populate the response template.
+      },
+    ],
+    "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
+      "candidate": "A String", # Required. The name of the candidate that produced the response.
+      "text": "A String", # Text response.
+      "value": "", # Fields and values that can be used to populate the response template.
+    },
+    "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate.
+      "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data.
+        "values": { # The values for fields in the prompt template.
+          "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+            "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                  "outcome": "A String", # Required. Outcome of the code execution.
+                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                },
+                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                  "code": "A String", # Required. The code to be executed.
+                  "language": "A String", # Required. Programming language of the `code`.
+                },
+                "fileData": { # URI based data. # Optional. URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                  "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "text": "A String", # Optional. Text part (can be code).
+                "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "endOffset": "A String", # Optional. The end offset of the video.
+                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                  "startOffset": "A String", # Optional. The start offset of the video.
+                },
+              },
+            ],
+            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+          },
+        },
+      },
+      "text": "A String", # Text prompt.
+      "value": "", # Fields and values that can be used to populate the prompt template.
+    },
+    "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
+      "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
+        "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
+        "groupId": "A String", # Unique identifier for the group.
+        "rubrics": [ # Rubrics that are part of this group.
+          { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+            "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+              "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+              },
+            },
+            "importance": "A String", # Optional. The relative importance of this rubric.
+            "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+            "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+          },
+        ],
+      },
+    },
+  },
+  "evaluationResponse": { # Evaluation result. # Output only. The response from evaluation.
+    "candidateResults": [ # Optional. The results for the metric.
+      { # Result for a single candidate.
+        "additionalResults": "", # Optional. Additional results for the metric.
+        "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.
+        "explanation": "A String", # Optional. The explanation for the metric.
+        "metric": "A String", # Required. The metric that was evaluated.
+        "rubricVerdicts": [ # Optional. The rubric verdicts for the metric.
+          { # Represents the verdict of an evaluation against a single rubric.
+            "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated.
+              "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                  "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                },
+              },
+              "importance": "A String", # Optional. The relative importance of this rubric.
+              "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+              "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+            },
+            "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict.
+            "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail".
+          },
+        ],
+        "score": 3.14, # Optional. The score for the metric.
+      },
+    ],
+    "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}
+    "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}
+    "metadata": "", # Optional. Metadata about the evaluation result.
+    "metric": "A String", # Required. The metric that was evaluated.
+    "request": { # Single evaluation request. # Required. The request that was evaluated.
+      "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+        { # Responses from model or agent.
+          "candidate": "A String", # Required. The name of the candidate that produced the response.
+          "text": "A String", # Text response.
+          "value": "", # Fields and values that can be used to populate the response template.
+        },
+      ],
+      "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
+        "candidate": "A String", # Required. The name of the candidate that produced the response.
+        "text": "A String", # Text response.
+        "value": "", # Fields and values that can be used to populate the response template.
+      },
+      "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate.
+        "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data.
+          "values": { # The values for fields in the prompt template.
+            "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+              "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                    "outcome": "A String", # Required. Outcome of the code execution.
+                    "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                  },
+                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                    "code": "A String", # Required. The code to be executed.
+                    "language": "A String", # Required. Programming language of the `code`.
+                  },
+                  "fileData": { # URI based data. # Optional. URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                    "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                    "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                    "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                      "a_key": "", # Properties of the object.
+                    },
+                  },
+                  "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "text": "A String", # Optional. Text part (can be code).
+                  "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                  "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                  "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                    "endOffset": "A String", # Optional. The end offset of the video.
+                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                    "startOffset": "A String", # Optional. The start offset of the video.
+                  },
+                },
+              ],
+              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+            },
+          },
+        },
+        "text": "A String", # Text prompt.
+        "value": "", # Fields and values that can be used to populate the prompt template.
+      },
+      "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
+        "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
+          "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
+          "groupId": "A String", # Unique identifier for the group.
+          "rubrics": [ # Rubrics that are part of this group.
+            { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+              "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                  "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                },
+              },
+              "importance": "A String", # Optional. The relative importance of this rubric.
+              "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+              "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+            },
+          ],
+        },
+      },
+    },
+  },
+  "gcsUri": "A String", # The GCS object where the request or response is stored.
+  "labels": { # Optional. Labels for the EvaluationItem.
+    "a_key": "A String",
+  },
+  "metadata": "", # Optional. Metadata for the EvaluationItem.
+  "name": "A String", # Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed.
+  "createTime": "A String", # Output only. Timestamp when this item was created.
+  "displayName": "A String", # Required. The display name of the EvaluationItem.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error for the evaluation item.
+    "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.
+  },
+  "evaluationItemType": "A String", # Required. The type of the EvaluationItem.
+  "evaluationRequest": { # Single evaluation request. # The request to evaluate.
+    "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+      { # Responses from model or agent.
+        "candidate": "A String", # Required. The name of the candidate that produced the response.
+        "text": "A String", # Text response.
+        "value": "", # Fields and values that can be used to populate the response template.
+      },
+    ],
+    "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
+      "candidate": "A String", # Required. The name of the candidate that produced the response.
+      "text": "A String", # Text response.
+      "value": "", # Fields and values that can be used to populate the response template.
+    },
+    "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate.
+      "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data.
+        "values": { # The values for fields in the prompt template.
+          "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+            "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                  "outcome": "A String", # Required. Outcome of the code execution.
+                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                },
+                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                  "code": "A String", # Required. The code to be executed.
+                  "language": "A String", # Required. Programming language of the `code`.
+                },
+                "fileData": { # URI based data. # Optional. URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                  "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "text": "A String", # Optional. Text part (can be code).
+                "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "endOffset": "A String", # Optional. The end offset of the video.
+                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                  "startOffset": "A String", # Optional. The start offset of the video.
+                },
+              },
+            ],
+            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+          },
+        },
+      },
+      "text": "A String", # Text prompt.
+      "value": "", # Fields and values that can be used to populate the prompt template.
+    },
+    "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
+      "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
+        "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
+        "groupId": "A String", # Unique identifier for the group.
+        "rubrics": [ # Rubrics that are part of this group.
+          { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+            "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+              "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+              },
+            },
+            "importance": "A String", # Optional. The relative importance of this rubric.
+            "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+            "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+          },
+        ],
+      },
+    },
+  },
+  "evaluationResponse": { # Evaluation result. # Output only. The response from evaluation.
+    "candidateResults": [ # Optional. The results for the metric.
+      { # Result for a single candidate.
+        "additionalResults": "", # Optional. Additional results for the metric.
+        "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.
+        "explanation": "A String", # Optional. The explanation for the metric.
+        "metric": "A String", # Required. The metric that was evaluated.
+        "rubricVerdicts": [ # Optional. The rubric verdicts for the metric.
+          { # Represents the verdict of an evaluation against a single rubric.
+            "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated.
+              "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                  "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                },
+              },
+              "importance": "A String", # Optional. The relative importance of this rubric.
+              "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+              "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+            },
+            "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict.
+            "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail".
+          },
+        ],
+        "score": 3.14, # Optional. The score for the metric.
+      },
+    ],
+    "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}
+    "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}
+    "metadata": "", # Optional. Metadata about the evaluation result.
+    "metric": "A String", # Required. The metric that was evaluated.
+    "request": { # Single evaluation request. # Required. The request that was evaluated.
+      "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+        { # Responses from model or agent.
+          "candidate": "A String", # Required. The name of the candidate that produced the response.
+          "text": "A String", # Text response.
+          "value": "", # Fields and values that can be used to populate the response template.
+        },
+      ],
+      "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
+        "candidate": "A String", # Required. The name of the candidate that produced the response.
+        "text": "A String", # Text response.
+        "value": "", # Fields and values that can be used to populate the response template.
+      },
+      "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate.
+        "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data.
+          "values": { # The values for fields in the prompt template.
+            "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+              "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                    "outcome": "A String", # Required. Outcome of the code execution.
+                    "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                  },
+                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                    "code": "A String", # Required. The code to be executed.
+                    "language": "A String", # Required. Programming language of the `code`.
+                  },
+                  "fileData": { # URI based data. # Optional. URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                    "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                    "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                    "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                      "a_key": "", # Properties of the object.
+                    },
+                  },
+                  "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "text": "A String", # Optional. Text part (can be code).
+                  "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                  "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                  "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                    "endOffset": "A String", # Optional. The end offset of the video.
+                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                    "startOffset": "A String", # Optional. The start offset of the video.
+                  },
+                },
+              ],
+              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+            },
+          },
+        },
+        "text": "A String", # Text prompt.
+        "value": "", # Fields and values that can be used to populate the prompt template.
+      },
+      "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
+        "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
+          "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
+          "groupId": "A String", # Unique identifier for the group.
+          "rubrics": [ # Rubrics that are part of this group.
+            { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+              "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                  "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                },
+              },
+              "importance": "A String", # Optional. The relative importance of this rubric.
+              "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+              "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+            },
+          ],
+        },
+      },
+    },
+  },
+  "gcsUri": "A String", # The GCS object where the request or response is stored.
+  "labels": { # Optional. Labels for the EvaluationItem.
+    "a_key": "A String",
+  },
+  "metadata": "", # Optional. Metadata for the EvaluationItem.
+  "name": "A String", # Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an Evaluation Item.
+
+Args:
+  name: string, Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an Evaluation Item.
+
+Args:
+  name: string, Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed.
+  "createTime": "A String", # Output only. Timestamp when this item was created.
+  "displayName": "A String", # Required. The display name of the EvaluationItem.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error for the evaluation item.
+    "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.
+  },
+  "evaluationItemType": "A String", # Required. The type of the EvaluationItem.
+  "evaluationRequest": { # Single evaluation request. # The request to evaluate.
+    "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+      { # Responses from model or agent.
+        "candidate": "A String", # Required. The name of the candidate that produced the response.
+        "text": "A String", # Text response.
+        "value": "", # Fields and values that can be used to populate the response template.
+      },
+    ],
+    "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
+      "candidate": "A String", # Required. The name of the candidate that produced the response.
+      "text": "A String", # Text response.
+      "value": "", # Fields and values that can be used to populate the response template.
+    },
+    "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate.
+      "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data.
+        "values": { # The values for fields in the prompt template.
+          "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+            "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                  "outcome": "A String", # Required. Outcome of the code execution.
+                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                },
+                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                  "code": "A String", # Required. The code to be executed.
+                  "language": "A String", # Required. Programming language of the `code`.
+                },
+                "fileData": { # URI based data. # Optional. URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                  "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "text": "A String", # Optional. Text part (can be code).
+                "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "endOffset": "A String", # Optional. The end offset of the video.
+                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                  "startOffset": "A String", # Optional. The start offset of the video.
+                },
+              },
+            ],
+            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+          },
+        },
+      },
+      "text": "A String", # Text prompt.
+      "value": "", # Fields and values that can be used to populate the prompt template.
+    },
+    "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
+      "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
+        "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
+        "groupId": "A String", # Unique identifier for the group.
+        "rubrics": [ # Rubrics that are part of this group.
+          { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+            "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+              "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+              },
+            },
+            "importance": "A String", # Optional. The relative importance of this rubric.
+            "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+            "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+          },
+        ],
+      },
+    },
+  },
+  "evaluationResponse": { # Evaluation result. # Output only. The response from evaluation.
+    "candidateResults": [ # Optional. The results for the metric.
+      { # Result for a single candidate.
+        "additionalResults": "", # Optional. Additional results for the metric.
+        "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.
+        "explanation": "A String", # Optional. The explanation for the metric.
+        "metric": "A String", # Required. The metric that was evaluated.
+        "rubricVerdicts": [ # Optional. The rubric verdicts for the metric.
+          { # Represents the verdict of an evaluation against a single rubric.
+            "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated.
+              "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                  "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                },
+              },
+              "importance": "A String", # Optional. The relative importance of this rubric.
+              "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+              "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+            },
+            "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict.
+            "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail".
+          },
+        ],
+        "score": 3.14, # Optional. The score for the metric.
+      },
+    ],
+    "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}
+    "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}
+    "metadata": "", # Optional. Metadata about the evaluation result.
+    "metric": "A String", # Required. The metric that was evaluated.
+    "request": { # Single evaluation request. # Required. The request that was evaluated.
+      "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+        { # Responses from model or agent.
+          "candidate": "A String", # Required. The name of the candidate that produced the response.
+          "text": "A String", # Text response.
+          "value": "", # Fields and values that can be used to populate the response template.
+        },
+      ],
+      "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
+        "candidate": "A String", # Required. The name of the candidate that produced the response.
+        "text": "A String", # Text response.
+        "value": "", # Fields and values that can be used to populate the response template.
+      },
+      "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate.
+        "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data.
+          "values": { # The values for fields in the prompt template.
+            "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+              "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                    "outcome": "A String", # Required. Outcome of the code execution.
+                    "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                  },
+                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                    "code": "A String", # Required. The code to be executed.
+                    "language": "A String", # Required. Programming language of the `code`.
+                  },
+                  "fileData": { # URI based data. # Optional. URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                    "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                    "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                    "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                      "a_key": "", # Properties of the object.
+                    },
+                  },
+                  "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "text": "A String", # Optional. Text part (can be code).
+                  "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                  "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                  "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                    "endOffset": "A String", # Optional. The end offset of the video.
+                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                    "startOffset": "A String", # Optional. The start offset of the video.
+                  },
+                },
+              ],
+              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+            },
+          },
+        },
+        "text": "A String", # Text prompt.
+        "value": "", # Fields and values that can be used to populate the prompt template.
+      },
+      "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
+        "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
+          "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
+          "groupId": "A String", # Unique identifier for the group.
+          "rubrics": [ # Rubrics that are part of this group.
+            { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+              "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                  "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                },
+              },
+              "importance": "A String", # Optional. The relative importance of this rubric.
+              "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+              "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+            },
+          ],
+        },
+      },
+    },
+  },
+  "gcsUri": "A String", # The GCS object where the request or response is stored.
+  "labels": { # Optional. Labels for the EvaluationItem.
+    "a_key": "A String",
+  },
+  "metadata": "", # Optional. Metadata for the EvaluationItem.
+  "name": "A String", # Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Evaluation Items.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
+  pageSize: integer, Optional. The maximum number of Evaluation Items to return.
+  pageToken: string, Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for EvaluationManagementService.ListEvaluationItems.
+  "evaluationItems": [ # List of EvaluationItems in the requested page.
+    { # EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed.
+      "createTime": "A String", # Output only. Timestamp when this item was created.
+      "displayName": "A String", # Required. The display name of the EvaluationItem.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error for the evaluation item.
+        "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.
+      },
+      "evaluationItemType": "A String", # Required. The type of the EvaluationItem.
+      "evaluationRequest": { # Single evaluation request. # The request to evaluate.
+        "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+          { # Responses from model or agent.
+            "candidate": "A String", # Required. The name of the candidate that produced the response.
+            "text": "A String", # Text response.
+            "value": "", # Fields and values that can be used to populate the response template.
+          },
+        ],
+        "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
+          "candidate": "A String", # Required. The name of the candidate that produced the response.
+          "text": "A String", # Text response.
+          "value": "", # Fields and values that can be used to populate the response template.
+        },
+        "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate.
+          "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data.
+            "values": { # The values for fields in the prompt template.
+              "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+                "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                    "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                      "outcome": "A String", # Required. Outcome of the code execution.
+                      "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                    },
+                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                      "code": "A String", # Required. The code to be executed.
+                      "language": "A String", # Required. Programming language of the `code`.
+                    },
+                    "fileData": { # URI based data. # Optional. URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                      "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                      "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                      "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                    "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "text": "A String", # Optional. Text part (can be code).
+                    "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                    "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                    "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                      "endOffset": "A String", # Optional. The end offset of the video.
+                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                      "startOffset": "A String", # Optional. The start offset of the video.
+                    },
+                  },
+                ],
+                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+              },
+            },
+          },
+          "text": "A String", # Text prompt.
+          "value": "", # Fields and values that can be used to populate the prompt template.
+        },
+        "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
+          "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
+            "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
+            "groupId": "A String", # Unique identifier for the group.
+            "rubrics": [ # Rubrics that are part of this group.
+              { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+                "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                  "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                    "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                  },
+                },
+                "importance": "A String", # Optional. The relative importance of this rubric.
+                "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+                "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+              },
+            ],
+          },
+        },
+      },
+      "evaluationResponse": { # Evaluation result. # Output only. The response from evaluation.
+        "candidateResults": [ # Optional. The results for the metric.
+          { # Result for a single candidate.
+            "additionalResults": "", # Optional. Additional results for the metric.
+            "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.
+            "explanation": "A String", # Optional. The explanation for the metric.
+            "metric": "A String", # Required. The metric that was evaluated.
+            "rubricVerdicts": [ # Optional. The rubric verdicts for the metric.
+              { # Represents the verdict of an evaluation against a single rubric.
+                "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated.
+                  "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                    "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                      "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                    },
+                  },
+                  "importance": "A String", # Optional. The relative importance of this rubric.
+                  "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+                  "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+                },
+                "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict.
+                "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail".
+              },
+            ],
+            "score": 3.14, # Optional. The score for the metric.
+          },
+        ],
+        "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}
+        "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}
+        "metadata": "", # Optional. Metadata about the evaluation result.
+        "metric": "A String", # Required. The metric that was evaluated.
+        "request": { # Single evaluation request. # Required. The request that was evaluated.
+          "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+            { # Responses from model or agent.
+              "candidate": "A String", # Required. The name of the candidate that produced the response.
+              "text": "A String", # Text response.
+              "value": "", # Fields and values that can be used to populate the response template.
+            },
+          ],
+          "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
+            "candidate": "A String", # Required. The name of the candidate that produced the response.
+            "text": "A String", # Text response.
+            "value": "", # Fields and values that can be used to populate the response template.
+          },
+          "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate.
+            "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data.
+              "values": { # The values for fields in the prompt template.
+                "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+                  "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+                    { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                      "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                        "outcome": "A String", # Required. Outcome of the code execution.
+                        "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                      },
+                      "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                        "code": "A String", # Required. The code to be executed.
+                        "language": "A String", # Required. Programming language of the `code`.
+                      },
+                      "fileData": { # URI based data. # Optional. URI based data.
+                        "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                        "fileUri": "A String", # Required. URI.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                      },
+                      "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                        "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                        "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                        "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                          "a_key": "", # Properties of the object.
+                        },
+                      },
+                      "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                        "data": "A String", # Required. Raw bytes.
+                        "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                      },
+                      "text": "A String", # Optional. Text part (can be code).
+                      "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                      "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                      "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                        "endOffset": "A String", # Optional. The end offset of the video.
+                        "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                        "startOffset": "A String", # Optional. The start offset of the video.
+                      },
+                    },
+                  ],
+                  "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+                },
+              },
+            },
+            "text": "A String", # Text prompt.
+            "value": "", # Fields and values that can be used to populate the prompt template.
+          },
+          "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
+            "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
+              "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
+              "groupId": "A String", # Unique identifier for the group.
+              "rubrics": [ # Rubrics that are part of this group.
+                { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+                  "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                    "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                      "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                    },
+                  },
+                  "importance": "A String", # Optional. The relative importance of this rubric.
+                  "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+                  "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+                },
+              ],
+            },
+          },
+        },
+      },
+      "gcsUri": "A String", # The GCS object where the request or response is stored.
+      "labels": { # Optional. Labels for the EvaluationItem.
+        "a_key": "A String",
+      },
+      "metadata": "", # Optional. Metadata for the EvaluationItem.
+      "name": "A String", # Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html new file mode 100644 index 00000000000..0be2d2ff604 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -0,0 +1,3218 @@ + + + +

Vertex AI API . projects . locations . evaluationRuns

+

Instance Methods

+

+ cancel(name, body=None, x__xgafv=None)

+

Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an Evaluation Run.

+

+ delete(name, x__xgafv=None)

+

Deletes an Evaluation Run.

+

+ get(name, x__xgafv=None)

+

Gets an Evaluation Run.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Evaluation Runs.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.
+
+Args:
+  name: string, Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EvaluationManagementService.CancelEvaluationRun.
+}
+
+  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.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an Evaluation Run.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.
+  "completionTime": "A String", # Output only. Time when the evaluation run was completed.
+  "createTime": "A String", # Output only. Time when the evaluation run was created.
+  "dataSource": { # The data source for the evaluation run. # Required. The data source for the evaluation run.
+    "bigqueryRequestSet": { # The request set for the evaluation run. # Evaluation data in bigquery.
+      "candidateResponseColumns": { # Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.
+        "a_key": "A String",
+      },
+      "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.
+      "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858).
+      "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource.
+        "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100.
+        "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0.
+        "samplingMethod": "A String", # Optional. The sampling method to use.
+      },
+      "uri": "A String", # Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId
+    },
+    "evaluationSet": "A String", # The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+  },
+  "displayName": "A String", # Required. The display name of the Evaluation Run.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.
+    "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.
+  },
+  "evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation.
+    "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run.
+      "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+      "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+        "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+        "candidateCount": 42, # Optional. Number of candidates to generate.
+        "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+        "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+        "logprobs": 42, # Optional. Logit probabilities.
+        "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+        "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+        "presencePenalty": 3.14, # Optional. Positive penalties.
+        "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+        "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+        "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+        "responseModalities": [ # Optional. The modalities of the response.
+          "A String",
+        ],
+        "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+          "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+          "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+            # Object with schema name: GoogleCloudAiplatformV1Schema
+          ],
+          "default": "", # Optional. Default value of the data.
+          "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+            "A String",
+          ],
+          "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+          "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+          "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+          "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+          "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+          "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+          "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+          "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+          "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+          "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+          "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+          "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+            "A String",
+          ],
+          "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "title": "A String", # Optional. The title of the Schema.
+          "type": "A String", # Optional. The type of the data.
+        },
+        "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+          "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+            "modelRoutingPreference": "A String", # The model routing preference.
+          },
+          "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+            "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+          },
+        },
+        "seed": 42, # Optional. Seed.
+        "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+          "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+          "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+              "voiceName": "A String", # The name of the preset voice to use.
+            },
+          },
+        },
+        "stopSequences": [ # Optional. Stop sequences.
+          "A String",
+        ],
+        "temperature": 3.14, # Optional. Controls the randomness of predictions.
+        "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+          "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+          "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+        },
+        "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+        "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+      },
+      "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.
+    },
+    "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.
+          "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+            "a_key": "", # Properties of the object.
+          },
+          "type": "A String", # Required. The type of the computation based metric.
+        },
+        "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+          "additionalConfig": { # Optional. Optional additional configuration for the metric.
+            "a_key": "", # Properties of the object.
+          },
+          "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater).
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+              "candidateCount": 42, # Optional. Number of candidates to generate.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+              "logprobs": 42, # Optional. Logit probabilities.
+              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "presencePenalty": 3.14, # Optional. Positive penalties.
+              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response.
+                "A String",
+              ],
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value of the data.
+                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. The description of the data.
+                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                  "A String",
+                ],
+                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                "nullable": True or False, # Optional. Indicates if the value may be null.
+                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. Required properties of Type.OBJECT.
+                  "A String",
+                ],
+                "title": "A String", # Optional. The title of the Schema.
+                "type": "A String", # Optional. The type of the data.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                },
+              },
+              "seed": 42, # Optional. Seed.
+              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                    "voiceName": "A String", # The name of the preset voice to use.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. Stop sequences.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of predictions.
+              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              },
+              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+            },
+            "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.
+          },
+          "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+          "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+            "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+            "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                "candidateCount": 42, # Optional. Number of candidates to generate.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                "logprobs": 42, # Optional. Logit probabilities.
+                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                "presencePenalty": 3.14, # Optional. Positive penalties.
+                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                "responseModalities": [ # Optional. The modalities of the response.
+                  "A String",
+                ],
+                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                  "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                  "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                    # Object with schema name: GoogleCloudAiplatformV1Schema
+                  ],
+                  "default": "", # Optional. Default value of the data.
+                  "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "description": "A String", # Optional. The description of the data.
+                  "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                  "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                  "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                  "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                  "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                  "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                  "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                  "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                  "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                  "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                  "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                  "nullable": True or False, # Optional. Indicates if the value may be null.
+                  "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                  "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                  "required": [ # Optional. Required properties of Type.OBJECT.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. The title of the Schema.
+                  "type": "A String", # Optional. The type of the data.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                  },
+                },
+                "seed": 42, # Optional. Seed.
+                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                      "voiceName": "A String", # The name of the preset voice to use.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. Stop sequences.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                },
+                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+              },
+              "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.
+            },
+            "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+          "systemInstruction": "A String", # Optional. System instructions for the judge model.
+        },
+        "metric": "A String", # Required. The name of the metric.
+        "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rubricBasedMetricSpec": { # Specification for a metric that is based on rubrics. # Spec for rubric based metric.
+          "inlineRubrics": { # Defines a list of rubrics, used when providing rubrics inline. # Use rubrics provided directly in the spec.
+            "rubrics": [ # The list of rubrics.
+              { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+                "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                  "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                    "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                  },
+                },
+                "importance": "A String", # Optional. The relative importance of this rubric.
+                "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+                "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+              },
+            ],
+          },
+          "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided.
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+              "candidateCount": 42, # Optional. Number of candidates to generate.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+              "logprobs": 42, # Optional. Logit probabilities.
+              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "presencePenalty": 3.14, # Optional. Positive penalties.
+              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response.
+                "A String",
+              ],
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value of the data.
+                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. The description of the data.
+                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                  "A String",
+                ],
+                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                "nullable": True or False, # Optional. Indicates if the value may be null.
+                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. Required properties of Type.OBJECT.
+                  "A String",
+                ],
+                "title": "A String", # Optional. The title of the Schema.
+                "type": "A String", # Optional. The type of the data.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                },
+              },
+              "seed": 42, # Optional. Seed.
+              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                    "voiceName": "A String", # The name of the preset voice to use.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. Stop sequences.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of predictions.
+              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              },
+              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+            },
+            "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.
+          },
+          "metricPromptTemplate": "A String", # Optional. Template for the prompt used by the judge model to evaluate against rubrics.
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification.
+            "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                "candidateCount": 42, # Optional. Number of candidates to generate.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                "logprobs": 42, # Optional. Logit probabilities.
+                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                "presencePenalty": 3.14, # Optional. Positive penalties.
+                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                "responseModalities": [ # Optional. The modalities of the response.
+                  "A String",
+                ],
+                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                  "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                  "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                    # Object with schema name: GoogleCloudAiplatformV1Schema
+                  ],
+                  "default": "", # Optional. Default value of the data.
+                  "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "description": "A String", # Optional. The description of the data.
+                  "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                  "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                  "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                  "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                  "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                  "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                  "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                  "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                  "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                  "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                  "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                  "nullable": True or False, # Optional. Indicates if the value may be null.
+                  "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                  "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                  "required": [ # Optional. Required properties of Type.OBJECT.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. The title of the Schema.
+                  "type": "A String", # Optional. The type of the data.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                  },
+                },
+                "seed": 42, # Optional. Seed.
+                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                      "voiceName": "A String", # The name of the preset voice to use.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. Stop sequences.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                },
+                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+              },
+              "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.
+            },
+            "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`.
+        },
+      },
+    ],
+    "outputConfig": { # The output config for the evaluation run. # Optional. The output config for the evaluation run.
+      "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery destination for evaluation output.
+        "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
+      },
+      "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud Storage destination for evaluation output.
+        "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+      },
+    },
+    "promptTemplate": { # Prompt template used for inference. # The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values.
+      "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt".
+      "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}"
+    },
+    "rubricConfigs": [ # Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation.
+      { # Configuration for a rubric group to be generated/saved for evaluation.
+        "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+          "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+              "candidateCount": 42, # Optional. Number of candidates to generate.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+              "logprobs": 42, # Optional. Logit probabilities.
+              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "presencePenalty": 3.14, # Optional. Positive penalties.
+              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response.
+                "A String",
+              ],
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value of the data.
+                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. The description of the data.
+                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                  "A String",
+                ],
+                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                "nullable": True or False, # Optional. Indicates if the value may be null.
+                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. Required properties of Type.OBJECT.
+                  "A String",
+                ],
+                "title": "A String", # Optional. The title of the Schema.
+                "type": "A String", # Optional. The type of the data.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                },
+              },
+              "seed": 42, # Optional. Seed.
+              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                    "voiceName": "A String", # The name of the preset voice to use.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. Stop sequences.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of predictions.
+              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              },
+              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+            },
+            "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.
+          },
+          "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+          "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+          "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+            "A String",
+          ],
+        },
+        "rubricGroupKey": "A String", # Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation.
+      },
+    ],
+  },
+  "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.
+    "evaluationSet": "A String", # The evaluation set where item level results are stored.
+    "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run.
+      "failedItems": 42, # Optional. The number of items that failed to be evaluated.
+      "metrics": { # Optional. Map of metric name to metric value.
+        "a_key": "",
+      },
+      "totalItems": 42, # Optional. The total number of items that were evaluated.
+    },
+  },
+  "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.
+      "generationConfig": { # Generation config. # Optional. Generation config.
+        "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+        "candidateCount": 42, # Optional. Number of candidates to generate.
+        "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+        "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+        "logprobs": 42, # Optional. Logit probabilities.
+        "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+        "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+        "presencePenalty": 3.14, # Optional. Positive penalties.
+        "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+        "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+        "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+        "responseModalities": [ # Optional. The modalities of the response.
+          "A String",
+        ],
+        "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+          "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+          "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+            # Object with schema name: GoogleCloudAiplatformV1Schema
+          ],
+          "default": "", # Optional. Default value of the data.
+          "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+            "A String",
+          ],
+          "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+          "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+          "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+          "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+          "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+          "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+          "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+          "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+          "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+          "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+          "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+          "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+            "A String",
+          ],
+          "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "title": "A String", # Optional. The title of the Schema.
+          "type": "A String", # Optional. The type of the data.
+        },
+        "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+          "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+            "modelRoutingPreference": "A String", # The model routing preference.
+          },
+          "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+            "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+          },
+        },
+        "seed": 42, # Optional. Seed.
+        "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+          "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+          "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+              "voiceName": "A String", # The name of the preset voice to use.
+            },
+          },
+        },
+        "stopSequences": [ # Optional. Stop sequences.
+          "A String",
+        ],
+        "temperature": 3.14, # Optional. Controls the randomness of predictions.
+        "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+          "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+          "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+        },
+        "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+        "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+      },
+      "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+    },
+  },
+  "labels": { # Optional. Labels for the evaluation run.
+    "a_key": "A String",
+  },
+  "metadata": "", # Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.
+  "name": "A String", # Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`
+  "state": "A String", # Output only. The state of the evaluation run.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.
+  "completionTime": "A String", # Output only. Time when the evaluation run was completed.
+  "createTime": "A String", # Output only. Time when the evaluation run was created.
+  "dataSource": { # The data source for the evaluation run. # Required. The data source for the evaluation run.
+    "bigqueryRequestSet": { # The request set for the evaluation run. # Evaluation data in bigquery.
+      "candidateResponseColumns": { # Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.
+        "a_key": "A String",
+      },
+      "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.
+      "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858).
+      "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource.
+        "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100.
+        "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0.
+        "samplingMethod": "A String", # Optional. The sampling method to use.
+      },
+      "uri": "A String", # Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId
+    },
+    "evaluationSet": "A String", # The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+  },
+  "displayName": "A String", # Required. The display name of the Evaluation Run.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.
+    "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.
+  },
+  "evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation.
+    "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run.
+      "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+      "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+        "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+        "candidateCount": 42, # Optional. Number of candidates to generate.
+        "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+        "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+        "logprobs": 42, # Optional. Logit probabilities.
+        "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+        "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+        "presencePenalty": 3.14, # Optional. Positive penalties.
+        "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+        "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+        "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+        "responseModalities": [ # Optional. The modalities of the response.
+          "A String",
+        ],
+        "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+          "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+          "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+            # Object with schema name: GoogleCloudAiplatformV1Schema
+          ],
+          "default": "", # Optional. Default value of the data.
+          "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+            "A String",
+          ],
+          "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+          "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+          "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+          "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+          "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+          "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+          "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+          "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+          "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+          "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+          "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+          "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+            "A String",
+          ],
+          "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "title": "A String", # Optional. The title of the Schema.
+          "type": "A String", # Optional. The type of the data.
+        },
+        "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+          "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+            "modelRoutingPreference": "A String", # The model routing preference.
+          },
+          "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+            "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+          },
+        },
+        "seed": 42, # Optional. Seed.
+        "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+          "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+          "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+              "voiceName": "A String", # The name of the preset voice to use.
+            },
+          },
+        },
+        "stopSequences": [ # Optional. Stop sequences.
+          "A String",
+        ],
+        "temperature": 3.14, # Optional. Controls the randomness of predictions.
+        "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+          "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+          "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+        },
+        "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+        "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+      },
+      "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.
+    },
+    "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.
+          "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+            "a_key": "", # Properties of the object.
+          },
+          "type": "A String", # Required. The type of the computation based metric.
+        },
+        "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+          "additionalConfig": { # Optional. Optional additional configuration for the metric.
+            "a_key": "", # Properties of the object.
+          },
+          "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater).
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+              "candidateCount": 42, # Optional. Number of candidates to generate.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+              "logprobs": 42, # Optional. Logit probabilities.
+              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "presencePenalty": 3.14, # Optional. Positive penalties.
+              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response.
+                "A String",
+              ],
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value of the data.
+                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. The description of the data.
+                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                  "A String",
+                ],
+                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                "nullable": True or False, # Optional. Indicates if the value may be null.
+                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. Required properties of Type.OBJECT.
+                  "A String",
+                ],
+                "title": "A String", # Optional. The title of the Schema.
+                "type": "A String", # Optional. The type of the data.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                },
+              },
+              "seed": 42, # Optional. Seed.
+              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                    "voiceName": "A String", # The name of the preset voice to use.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. Stop sequences.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of predictions.
+              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              },
+              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+            },
+            "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.
+          },
+          "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+          "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+            "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+            "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                "candidateCount": 42, # Optional. Number of candidates to generate.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                "logprobs": 42, # Optional. Logit probabilities.
+                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                "presencePenalty": 3.14, # Optional. Positive penalties.
+                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                "responseModalities": [ # Optional. The modalities of the response.
+                  "A String",
+                ],
+                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                  "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                  "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                    # Object with schema name: GoogleCloudAiplatformV1Schema
+                  ],
+                  "default": "", # Optional. Default value of the data.
+                  "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "description": "A String", # Optional. The description of the data.
+                  "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                  "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                  "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                  "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                  "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                  "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                  "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                  "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                  "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                  "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                  "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                  "nullable": True or False, # Optional. Indicates if the value may be null.
+                  "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                  "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                  "required": [ # Optional. Required properties of Type.OBJECT.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. The title of the Schema.
+                  "type": "A String", # Optional. The type of the data.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                  },
+                },
+                "seed": 42, # Optional. Seed.
+                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                      "voiceName": "A String", # The name of the preset voice to use.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. Stop sequences.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                },
+                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+              },
+              "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.
+            },
+            "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+          "systemInstruction": "A String", # Optional. System instructions for the judge model.
+        },
+        "metric": "A String", # Required. The name of the metric.
+        "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rubricBasedMetricSpec": { # Specification for a metric that is based on rubrics. # Spec for rubric based metric.
+          "inlineRubrics": { # Defines a list of rubrics, used when providing rubrics inline. # Use rubrics provided directly in the spec.
+            "rubrics": [ # The list of rubrics.
+              { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+                "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                  "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                    "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                  },
+                },
+                "importance": "A String", # Optional. The relative importance of this rubric.
+                "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+                "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+              },
+            ],
+          },
+          "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided.
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+              "candidateCount": 42, # Optional. Number of candidates to generate.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+              "logprobs": 42, # Optional. Logit probabilities.
+              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "presencePenalty": 3.14, # Optional. Positive penalties.
+              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response.
+                "A String",
+              ],
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value of the data.
+                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. The description of the data.
+                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                  "A String",
+                ],
+                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                "nullable": True or False, # Optional. Indicates if the value may be null.
+                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. Required properties of Type.OBJECT.
+                  "A String",
+                ],
+                "title": "A String", # Optional. The title of the Schema.
+                "type": "A String", # Optional. The type of the data.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                },
+              },
+              "seed": 42, # Optional. Seed.
+              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                    "voiceName": "A String", # The name of the preset voice to use.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. Stop sequences.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of predictions.
+              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              },
+              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+            },
+            "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.
+          },
+          "metricPromptTemplate": "A String", # Optional. Template for the prompt used by the judge model to evaluate against rubrics.
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification.
+            "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                "candidateCount": 42, # Optional. Number of candidates to generate.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                "logprobs": 42, # Optional. Logit probabilities.
+                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                "presencePenalty": 3.14, # Optional. Positive penalties.
+                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                "responseModalities": [ # Optional. The modalities of the response.
+                  "A String",
+                ],
+                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                  "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                  "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                    # Object with schema name: GoogleCloudAiplatformV1Schema
+                  ],
+                  "default": "", # Optional. Default value of the data.
+                  "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "description": "A String", # Optional. The description of the data.
+                  "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                  "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                  "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                  "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                  "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                  "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                  "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                  "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                  "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                  "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                  "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                  "nullable": True or False, # Optional. Indicates if the value may be null.
+                  "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                  "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                  "required": [ # Optional. Required properties of Type.OBJECT.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. The title of the Schema.
+                  "type": "A String", # Optional. The type of the data.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                  },
+                },
+                "seed": 42, # Optional. Seed.
+                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                      "voiceName": "A String", # The name of the preset voice to use.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. Stop sequences.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                },
+                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+              },
+              "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.
+            },
+            "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`.
+        },
+      },
+    ],
+    "outputConfig": { # The output config for the evaluation run. # Optional. The output config for the evaluation run.
+      "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery destination for evaluation output.
+        "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
+      },
+      "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud Storage destination for evaluation output.
+        "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+      },
+    },
+    "promptTemplate": { # Prompt template used for inference. # The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values.
+      "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt".
+      "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}"
+    },
+    "rubricConfigs": [ # Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation.
+      { # Configuration for a rubric group to be generated/saved for evaluation.
+        "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+          "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+              "candidateCount": 42, # Optional. Number of candidates to generate.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+              "logprobs": 42, # Optional. Logit probabilities.
+              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "presencePenalty": 3.14, # Optional. Positive penalties.
+              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response.
+                "A String",
+              ],
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value of the data.
+                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. The description of the data.
+                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                  "A String",
+                ],
+                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                "nullable": True or False, # Optional. Indicates if the value may be null.
+                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. Required properties of Type.OBJECT.
+                  "A String",
+                ],
+                "title": "A String", # Optional. The title of the Schema.
+                "type": "A String", # Optional. The type of the data.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                },
+              },
+              "seed": 42, # Optional. Seed.
+              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                    "voiceName": "A String", # The name of the preset voice to use.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. Stop sequences.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of predictions.
+              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              },
+              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+            },
+            "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.
+          },
+          "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+          "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+          "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+            "A String",
+          ],
+        },
+        "rubricGroupKey": "A String", # Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation.
+      },
+    ],
+  },
+  "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.
+    "evaluationSet": "A String", # The evaluation set where item level results are stored.
+    "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run.
+      "failedItems": 42, # Optional. The number of items that failed to be evaluated.
+      "metrics": { # Optional. Map of metric name to metric value.
+        "a_key": "",
+      },
+      "totalItems": 42, # Optional. The total number of items that were evaluated.
+    },
+  },
+  "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.
+      "generationConfig": { # Generation config. # Optional. Generation config.
+        "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+        "candidateCount": 42, # Optional. Number of candidates to generate.
+        "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+        "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+        "logprobs": 42, # Optional. Logit probabilities.
+        "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+        "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+        "presencePenalty": 3.14, # Optional. Positive penalties.
+        "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+        "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+        "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+        "responseModalities": [ # Optional. The modalities of the response.
+          "A String",
+        ],
+        "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+          "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+          "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+            # Object with schema name: GoogleCloudAiplatformV1Schema
+          ],
+          "default": "", # Optional. Default value of the data.
+          "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+            "A String",
+          ],
+          "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+          "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+          "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+          "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+          "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+          "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+          "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+          "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+          "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+          "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+          "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+          "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+            "A String",
+          ],
+          "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "title": "A String", # Optional. The title of the Schema.
+          "type": "A String", # Optional. The type of the data.
+        },
+        "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+          "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+            "modelRoutingPreference": "A String", # The model routing preference.
+          },
+          "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+            "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+          },
+        },
+        "seed": 42, # Optional. Seed.
+        "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+          "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+          "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+              "voiceName": "A String", # The name of the preset voice to use.
+            },
+          },
+        },
+        "stopSequences": [ # Optional. Stop sequences.
+          "A String",
+        ],
+        "temperature": 3.14, # Optional. Controls the randomness of predictions.
+        "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+          "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+          "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+        },
+        "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+        "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+      },
+      "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+    },
+  },
+  "labels": { # Optional. Labels for the evaluation run.
+    "a_key": "A String",
+  },
+  "metadata": "", # Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.
+  "name": "A String", # Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`
+  "state": "A String", # Output only. The state of the evaluation run.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an Evaluation Run.
+
+Args:
+  name: string, Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an Evaluation Run.
+
+Args:
+  name: string, Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.
+  "completionTime": "A String", # Output only. Time when the evaluation run was completed.
+  "createTime": "A String", # Output only. Time when the evaluation run was created.
+  "dataSource": { # The data source for the evaluation run. # Required. The data source for the evaluation run.
+    "bigqueryRequestSet": { # The request set for the evaluation run. # Evaluation data in bigquery.
+      "candidateResponseColumns": { # Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.
+        "a_key": "A String",
+      },
+      "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.
+      "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858).
+      "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource.
+        "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100.
+        "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0.
+        "samplingMethod": "A String", # Optional. The sampling method to use.
+      },
+      "uri": "A String", # Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId
+    },
+    "evaluationSet": "A String", # The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+  },
+  "displayName": "A String", # Required. The display name of the Evaluation Run.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.
+    "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.
+  },
+  "evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation.
+    "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run.
+      "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+      "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+        "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+        "candidateCount": 42, # Optional. Number of candidates to generate.
+        "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+        "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+        "logprobs": 42, # Optional. Logit probabilities.
+        "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+        "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+        "presencePenalty": 3.14, # Optional. Positive penalties.
+        "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+        "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+        "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+        "responseModalities": [ # Optional. The modalities of the response.
+          "A String",
+        ],
+        "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+          "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+          "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+            # Object with schema name: GoogleCloudAiplatformV1Schema
+          ],
+          "default": "", # Optional. Default value of the data.
+          "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+            "A String",
+          ],
+          "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+          "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+          "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+          "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+          "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+          "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+          "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+          "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+          "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+          "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+          "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+          "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+            "A String",
+          ],
+          "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "title": "A String", # Optional. The title of the Schema.
+          "type": "A String", # Optional. The type of the data.
+        },
+        "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+          "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+            "modelRoutingPreference": "A String", # The model routing preference.
+          },
+          "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+            "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+          },
+        },
+        "seed": 42, # Optional. Seed.
+        "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+          "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+          "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+              "voiceName": "A String", # The name of the preset voice to use.
+            },
+          },
+        },
+        "stopSequences": [ # Optional. Stop sequences.
+          "A String",
+        ],
+        "temperature": 3.14, # Optional. Controls the randomness of predictions.
+        "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+          "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+          "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+        },
+        "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+        "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+      },
+      "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.
+    },
+    "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.
+          "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+            "a_key": "", # Properties of the object.
+          },
+          "type": "A String", # Required. The type of the computation based metric.
+        },
+        "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+          "additionalConfig": { # Optional. Optional additional configuration for the metric.
+            "a_key": "", # Properties of the object.
+          },
+          "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater).
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+              "candidateCount": 42, # Optional. Number of candidates to generate.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+              "logprobs": 42, # Optional. Logit probabilities.
+              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "presencePenalty": 3.14, # Optional. Positive penalties.
+              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response.
+                "A String",
+              ],
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value of the data.
+                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. The description of the data.
+                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                  "A String",
+                ],
+                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                "nullable": True or False, # Optional. Indicates if the value may be null.
+                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. Required properties of Type.OBJECT.
+                  "A String",
+                ],
+                "title": "A String", # Optional. The title of the Schema.
+                "type": "A String", # Optional. The type of the data.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                },
+              },
+              "seed": 42, # Optional. Seed.
+              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                    "voiceName": "A String", # The name of the preset voice to use.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. Stop sequences.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of predictions.
+              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              },
+              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+            },
+            "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.
+          },
+          "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+          "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+            "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+            "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                "candidateCount": 42, # Optional. Number of candidates to generate.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                "logprobs": 42, # Optional. Logit probabilities.
+                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                "presencePenalty": 3.14, # Optional. Positive penalties.
+                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                "responseModalities": [ # Optional. The modalities of the response.
+                  "A String",
+                ],
+                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                  "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                  "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                    # Object with schema name: GoogleCloudAiplatformV1Schema
+                  ],
+                  "default": "", # Optional. Default value of the data.
+                  "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "description": "A String", # Optional. The description of the data.
+                  "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                  "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                  "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                  "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                  "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                  "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                  "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                  "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                  "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                  "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                  "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                  "nullable": True or False, # Optional. Indicates if the value may be null.
+                  "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                  "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                  "required": [ # Optional. Required properties of Type.OBJECT.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. The title of the Schema.
+                  "type": "A String", # Optional. The type of the data.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                  },
+                },
+                "seed": 42, # Optional. Seed.
+                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                      "voiceName": "A String", # The name of the preset voice to use.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. Stop sequences.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                },
+                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+              },
+              "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.
+            },
+            "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+          "systemInstruction": "A String", # Optional. System instructions for the judge model.
+        },
+        "metric": "A String", # Required. The name of the metric.
+        "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rubricBasedMetricSpec": { # Specification for a metric that is based on rubrics. # Spec for rubric based metric.
+          "inlineRubrics": { # Defines a list of rubrics, used when providing rubrics inline. # Use rubrics provided directly in the spec.
+            "rubrics": [ # The list of rubrics.
+              { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+                "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                  "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                    "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                  },
+                },
+                "importance": "A String", # Optional. The relative importance of this rubric.
+                "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+                "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+              },
+            ],
+          },
+          "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided.
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+              "candidateCount": 42, # Optional. Number of candidates to generate.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+              "logprobs": 42, # Optional. Logit probabilities.
+              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "presencePenalty": 3.14, # Optional. Positive penalties.
+              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response.
+                "A String",
+              ],
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value of the data.
+                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. The description of the data.
+                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                  "A String",
+                ],
+                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                "nullable": True or False, # Optional. Indicates if the value may be null.
+                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. Required properties of Type.OBJECT.
+                  "A String",
+                ],
+                "title": "A String", # Optional. The title of the Schema.
+                "type": "A String", # Optional. The type of the data.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                },
+              },
+              "seed": 42, # Optional. Seed.
+              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                    "voiceName": "A String", # The name of the preset voice to use.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. Stop sequences.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of predictions.
+              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              },
+              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+            },
+            "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.
+          },
+          "metricPromptTemplate": "A String", # Optional. Template for the prompt used by the judge model to evaluate against rubrics.
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification.
+            "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                "candidateCount": 42, # Optional. Number of candidates to generate.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                "logprobs": 42, # Optional. Logit probabilities.
+                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                "presencePenalty": 3.14, # Optional. Positive penalties.
+                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                "responseModalities": [ # Optional. The modalities of the response.
+                  "A String",
+                ],
+                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                  "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                  "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                    # Object with schema name: GoogleCloudAiplatformV1Schema
+                  ],
+                  "default": "", # Optional. Default value of the data.
+                  "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "description": "A String", # Optional. The description of the data.
+                  "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                  "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                  "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                  "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                  "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                  "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                  "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                  "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                  "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                  "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                  "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                  "nullable": True or False, # Optional. Indicates if the value may be null.
+                  "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                  "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                  "required": [ # Optional. Required properties of Type.OBJECT.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. The title of the Schema.
+                  "type": "A String", # Optional. The type of the data.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                  },
+                },
+                "seed": 42, # Optional. Seed.
+                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                      "voiceName": "A String", # The name of the preset voice to use.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. Stop sequences.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                },
+                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+              },
+              "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.
+            },
+            "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`.
+        },
+      },
+    ],
+    "outputConfig": { # The output config for the evaluation run. # Optional. The output config for the evaluation run.
+      "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery destination for evaluation output.
+        "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
+      },
+      "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud Storage destination for evaluation output.
+        "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+      },
+    },
+    "promptTemplate": { # Prompt template used for inference. # The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values.
+      "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt".
+      "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}"
+    },
+    "rubricConfigs": [ # Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation.
+      { # Configuration for a rubric group to be generated/saved for evaluation.
+        "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+          "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+              "candidateCount": 42, # Optional. Number of candidates to generate.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+              "logprobs": 42, # Optional. Logit probabilities.
+              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "presencePenalty": 3.14, # Optional. Positive penalties.
+              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response.
+                "A String",
+              ],
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value of the data.
+                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. The description of the data.
+                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                  "A String",
+                ],
+                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                "nullable": True or False, # Optional. Indicates if the value may be null.
+                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                "required": [ # Optional. Required properties of Type.OBJECT.
+                  "A String",
+                ],
+                "title": "A String", # Optional. The title of the Schema.
+                "type": "A String", # Optional. The type of the data.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                },
+              },
+              "seed": 42, # Optional. Seed.
+              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                    "voiceName": "A String", # The name of the preset voice to use.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. Stop sequences.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of predictions.
+              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              },
+              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+            },
+            "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.
+          },
+          "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+          "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+          "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+            "A String",
+          ],
+        },
+        "rubricGroupKey": "A String", # Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation.
+      },
+    ],
+  },
+  "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.
+    "evaluationSet": "A String", # The evaluation set where item level results are stored.
+    "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run.
+      "failedItems": 42, # Optional. The number of items that failed to be evaluated.
+      "metrics": { # Optional. Map of metric name to metric value.
+        "a_key": "",
+      },
+      "totalItems": 42, # Optional. The total number of items that were evaluated.
+    },
+  },
+  "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.
+      "generationConfig": { # Generation config. # Optional. Generation config.
+        "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+        "candidateCount": 42, # Optional. Number of candidates to generate.
+        "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+        "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+        "logprobs": 42, # Optional. Logit probabilities.
+        "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+        "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+        "presencePenalty": 3.14, # Optional. Positive penalties.
+        "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+        "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+        "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+        "responseModalities": [ # Optional. The modalities of the response.
+          "A String",
+        ],
+        "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+          "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+          "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+            # Object with schema name: GoogleCloudAiplatformV1Schema
+          ],
+          "default": "", # Optional. Default value of the data.
+          "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+            "A String",
+          ],
+          "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+          "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+          "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+          "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+          "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+          "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+          "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+          "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+          "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+          "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+          "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+          "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+          },
+          "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+            "A String",
+          ],
+          "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "title": "A String", # Optional. The title of the Schema.
+          "type": "A String", # Optional. The type of the data.
+        },
+        "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+          "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+            "modelRoutingPreference": "A String", # The model routing preference.
+          },
+          "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+            "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+          },
+        },
+        "seed": 42, # Optional. Seed.
+        "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+          "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+          "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+              "voiceName": "A String", # The name of the preset voice to use.
+            },
+          },
+        },
+        "stopSequences": [ # Optional. Stop sequences.
+          "A String",
+        ],
+        "temperature": 3.14, # Optional. Controls the randomness of predictions.
+        "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+          "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+          "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+        },
+        "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+        "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+      },
+      "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+    },
+  },
+  "labels": { # Optional. Labels for the evaluation run.
+    "a_key": "A String",
+  },
+  "metadata": "", # Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.
+  "name": "A String", # Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`
+  "state": "A String", # Output only. The state of the evaluation run.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Evaluation Runs.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
+  pageSize: integer, Optional. The maximum number of Evaluation Runs to return.
+  pageToken: string, Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for EvaluationManagementService.ListEvaluationRuns.
+  "evaluationRuns": [ # List of EvaluationRuns in the requested page.
+    { # EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.
+      "completionTime": "A String", # Output only. Time when the evaluation run was completed.
+      "createTime": "A String", # Output only. Time when the evaluation run was created.
+      "dataSource": { # The data source for the evaluation run. # Required. The data source for the evaluation run.
+        "bigqueryRequestSet": { # The request set for the evaluation run. # Evaluation data in bigquery.
+          "candidateResponseColumns": { # Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.
+            "a_key": "A String",
+          },
+          "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.
+          "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858).
+          "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource.
+            "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100.
+            "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0.
+            "samplingMethod": "A String", # Optional. The sampling method to use.
+          },
+          "uri": "A String", # Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId
+        },
+        "evaluationSet": "A String", # The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+      },
+      "displayName": "A String", # Required. The display name of the Evaluation Run.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.
+        "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.
+      },
+      "evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation.
+        "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run.
+          "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+          "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+            "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+            "candidateCount": 42, # Optional. Number of candidates to generate.
+            "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+            "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+            "logprobs": 42, # Optional. Logit probabilities.
+            "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+            "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+            "presencePenalty": 3.14, # Optional. Positive penalties.
+            "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+            "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+            "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+            "responseModalities": [ # Optional. The modalities of the response.
+              "A String",
+            ],
+            "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+              "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+              "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                # Object with schema name: GoogleCloudAiplatformV1Schema
+              ],
+              "default": "", # Optional. Default value of the data.
+              "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "description": "A String", # Optional. The description of the data.
+              "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                "A String",
+              ],
+              "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+              "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+              "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+              "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+              "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+              "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+              "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+              "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+              "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+              "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+              "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+              "nullable": True or False, # Optional. Indicates if the value may be null.
+              "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+              "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                "A String",
+              ],
+              "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+              "required": [ # Optional. Required properties of Type.OBJECT.
+                "A String",
+              ],
+              "title": "A String", # Optional. The title of the Schema.
+              "type": "A String", # Optional. The type of the data.
+            },
+            "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+              "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                "modelRoutingPreference": "A String", # The model routing preference.
+              },
+              "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+              },
+            },
+            "seed": 42, # Optional. Seed.
+            "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+              "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+              "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                  "voiceName": "A String", # The name of the preset voice to use.
+                },
+              },
+            },
+            "stopSequences": [ # Optional. Stop sequences.
+              "A String",
+            ],
+            "temperature": 3.14, # Optional. Controls the randomness of predictions.
+            "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+              "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+              "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+            },
+            "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+            "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+          },
+          "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.
+        },
+        "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.
+              "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+                "a_key": "", # Properties of the object.
+              },
+              "type": "A String", # Required. The type of the computation based metric.
+            },
+            "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+              "additionalConfig": { # Optional. Optional additional configuration for the metric.
+                "a_key": "", # Properties of the object.
+              },
+              "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater).
+                "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+                "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                  "candidateCount": 42, # Optional. Number of candidates to generate.
+                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                  "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                  "logprobs": 42, # Optional. Logit probabilities.
+                  "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                  "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                  "presencePenalty": 3.14, # Optional. Positive penalties.
+                  "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                  "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                  "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                  "responseModalities": [ # Optional. The modalities of the response.
+                    "A String",
+                  ],
+                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                    "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                    "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                      # Object with schema name: GoogleCloudAiplatformV1Schema
+                    ],
+                    "default": "", # Optional. Default value of the data.
+                    "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                      "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                    },
+                    "description": "A String", # Optional. The description of the data.
+                    "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                      "A String",
+                    ],
+                    "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                    "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                    "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                    "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                    "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                    "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                    "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                    "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                    "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                    "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                    "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                    "nullable": True or False, # Optional. Indicates if the value may be null.
+                    "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                    "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                      "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                    },
+                    "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                      "A String",
+                    ],
+                    "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                    "required": [ # Optional. Required properties of Type.OBJECT.
+                      "A String",
+                    ],
+                    "title": "A String", # Optional. The title of the Schema.
+                    "type": "A String", # Optional. The type of the data.
+                  },
+                  "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                    "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                      "modelRoutingPreference": "A String", # The model routing preference.
+                    },
+                    "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                      "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                    },
+                  },
+                  "seed": 42, # Optional. Seed.
+                  "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                    "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                    "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                      "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                        "voiceName": "A String", # The name of the preset voice to use.
+                      },
+                    },
+                  },
+                  "stopSequences": [ # Optional. Stop sequences.
+                    "A String",
+                  ],
+                  "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                  "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                    "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                    "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                  },
+                  "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                  "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                },
+                "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.
+              },
+              "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+              "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+                "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+                "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+                "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+                  "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+                  "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                    "candidateCount": 42, # Optional. Number of candidates to generate.
+                    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                    "logprobs": 42, # Optional. Logit probabilities.
+                    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                    "presencePenalty": 3.14, # Optional. Positive penalties.
+                    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                    "responseModalities": [ # Optional. The modalities of the response.
+                      "A String",
+                    ],
+                    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                      "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                      "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                        # Object with schema name: GoogleCloudAiplatformV1Schema
+                      ],
+                      "default": "", # Optional. Default value of the data.
+                      "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                        "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                      },
+                      "description": "A String", # Optional. The description of the data.
+                      "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                        "A String",
+                      ],
+                      "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                      "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                      "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                      "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                      "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                      "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                      "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                      "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                      "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                      "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                      "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                      "nullable": True or False, # Optional. Indicates if the value may be null.
+                      "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                      "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                        "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                      },
+                      "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                        "A String",
+                      ],
+                      "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                      "required": [ # Optional. Required properties of Type.OBJECT.
+                        "A String",
+                      ],
+                      "title": "A String", # Optional. The title of the Schema.
+                      "type": "A String", # Optional. The type of the data.
+                    },
+                    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                        "modelRoutingPreference": "A String", # The model routing preference.
+                      },
+                      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                      },
+                    },
+                    "seed": 42, # Optional. Seed.
+                    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                          "voiceName": "A String", # The name of the preset voice to use.
+                        },
+                      },
+                    },
+                    "stopSequences": [ # Optional. Stop sequences.
+                      "A String",
+                    ],
+                    "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                    },
+                    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                  },
+                  "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.
+                },
+                "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+                "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+                "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+                  "A String",
+                ],
+              },
+              "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+              "systemInstruction": "A String", # Optional. System instructions for the judge model.
+            },
+            "metric": "A String", # Required. The name of the metric.
+            "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric.
+              "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+              "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+                "a_key": "", # Properties of the object.
+              },
+            },
+            "rubricBasedMetricSpec": { # Specification for a metric that is based on rubrics. # Spec for rubric based metric.
+              "inlineRubrics": { # Defines a list of rubrics, used when providing rubrics inline. # Use rubrics provided directly in the spec.
+                "rubrics": [ # The list of rubrics.
+                  { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
+                    "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
+                      "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
+                        "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
+                      },
+                    },
+                    "importance": "A String", # Optional. The relative importance of this rubric.
+                    "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
+                    "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+                  },
+                ],
+              },
+              "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided.
+                "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+                "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                  "candidateCount": 42, # Optional. Number of candidates to generate.
+                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                  "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                  "logprobs": 42, # Optional. Logit probabilities.
+                  "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                  "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                  "presencePenalty": 3.14, # Optional. Positive penalties.
+                  "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                  "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                  "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                  "responseModalities": [ # Optional. The modalities of the response.
+                    "A String",
+                  ],
+                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                    "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                    "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                      # Object with schema name: GoogleCloudAiplatformV1Schema
+                    ],
+                    "default": "", # Optional. Default value of the data.
+                    "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                      "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                    },
+                    "description": "A String", # Optional. The description of the data.
+                    "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                      "A String",
+                    ],
+                    "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                    "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                    "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                    "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                    "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                    "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                    "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                    "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                    "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                    "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                    "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                    "nullable": True or False, # Optional. Indicates if the value may be null.
+                    "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                    "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                      "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                    },
+                    "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                      "A String",
+                    ],
+                    "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                    "required": [ # Optional. Required properties of Type.OBJECT.
+                      "A String",
+                    ],
+                    "title": "A String", # Optional. The title of the Schema.
+                    "type": "A String", # Optional. The type of the data.
+                  },
+                  "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                    "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                      "modelRoutingPreference": "A String", # The model routing preference.
+                    },
+                    "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                      "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                    },
+                  },
+                  "seed": 42, # Optional. Seed.
+                  "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                    "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                    "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                      "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                        "voiceName": "A String", # The name of the preset voice to use.
+                      },
+                    },
+                  },
+                  "stopSequences": [ # Optional. Stop sequences.
+                    "A String",
+                  ],
+                  "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                  "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                    "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                    "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                  },
+                  "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                  "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                },
+                "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.
+              },
+              "metricPromptTemplate": "A String", # Optional. Template for the prompt used by the judge model to evaluate against rubrics.
+              "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification.
+                "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+                  "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+                  "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                    "candidateCount": 42, # Optional. Number of candidates to generate.
+                    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                    "logprobs": 42, # Optional. Logit probabilities.
+                    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                    "presencePenalty": 3.14, # Optional. Positive penalties.
+                    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                    "responseModalities": [ # Optional. The modalities of the response.
+                      "A String",
+                    ],
+                    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                      "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                      "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                        # Object with schema name: GoogleCloudAiplatformV1Schema
+                      ],
+                      "default": "", # Optional. Default value of the data.
+                      "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                        "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                      },
+                      "description": "A String", # Optional. The description of the data.
+                      "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                        "A String",
+                      ],
+                      "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                      "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                      "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                      "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                      "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                      "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                      "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                      "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                      "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                      "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                      "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                      "nullable": True or False, # Optional. Indicates if the value may be null.
+                      "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                      "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                        "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                      },
+                      "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                        "A String",
+                      ],
+                      "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                      "required": [ # Optional. Required properties of Type.OBJECT.
+                        "A String",
+                      ],
+                      "title": "A String", # Optional. The title of the Schema.
+                      "type": "A String", # Optional. The type of the data.
+                    },
+                    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                        "modelRoutingPreference": "A String", # The model routing preference.
+                      },
+                      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                      },
+                    },
+                    "seed": 42, # Optional. Seed.
+                    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                          "voiceName": "A String", # The name of the preset voice to use.
+                        },
+                      },
+                    },
+                    "stopSequences": [ # Optional. Stop sequences.
+                      "A String",
+                    ],
+                    "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                    },
+                    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                  },
+                  "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.
+                },
+                "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+                "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+                "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+                  "A String",
+                ],
+              },
+              "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`.
+            },
+          },
+        ],
+        "outputConfig": { # The output config for the evaluation run. # Optional. The output config for the evaluation run.
+          "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery destination for evaluation output.
+            "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
+          },
+          "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud Storage destination for evaluation output.
+            "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
+          },
+        },
+        "promptTemplate": { # Prompt template used for inference. # The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values.
+          "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt".
+          "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}"
+        },
+        "rubricConfigs": [ # Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation.
+          { # Configuration for a rubric group to be generated/saved for evaluation.
+            "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+              "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+              "parameters": { # Optional. The parameters needed to run the pre-defined metric.
+                "a_key": "", # Properties of the object.
+              },
+            },
+            "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+              "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+                "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+                "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
+                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+                  "candidateCount": 42, # Optional. Number of candidates to generate.
+                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+                  "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+                  "logprobs": 42, # Optional. Logit probabilities.
+                  "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+                  "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                  "presencePenalty": 3.14, # Optional. Positive penalties.
+                  "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+                  "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+                  "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                  "responseModalities": [ # Optional. The modalities of the response.
+                    "A String",
+                  ],
+                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                    "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+                    "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                      # Object with schema name: GoogleCloudAiplatformV1Schema
+                    ],
+                    "default": "", # Optional. Default value of the data.
+                    "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                      "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                    },
+                    "description": "A String", # Optional. The description of the data.
+                    "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                      "A String",
+                    ],
+                    "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+                    "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+                    "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+                    "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+                    "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+                    "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+                    "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+                    "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+                    "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+                    "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+                    "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+                    "nullable": True or False, # Optional. Indicates if the value may be null.
+                    "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+                    "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                      "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                    },
+                    "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                      "A String",
+                    ],
+                    "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+                    "required": [ # Optional. Required properties of Type.OBJECT.
+                      "A String",
+                    ],
+                    "title": "A String", # Optional. The title of the Schema.
+                    "type": "A String", # Optional. The type of the data.
+                  },
+                  "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+                    "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                      "modelRoutingPreference": "A String", # The model routing preference.
+                    },
+                    "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                      "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                    },
+                  },
+                  "seed": 42, # Optional. Seed.
+                  "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+                    "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+                    "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                      "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                        "voiceName": "A String", # The name of the preset voice to use.
+                      },
+                    },
+                  },
+                  "stopSequences": [ # Optional. Stop sequences.
+                    "A String",
+                  ],
+                  "temperature": 3.14, # Optional. Controls the randomness of predictions.
+                  "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                    "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+                    "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                  },
+                  "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+                  "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                },
+                "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.
+              },
+              "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+              "rubricContentType": "A String", # Optional. The type of rubric content to be generated.
+              "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+                "A String",
+              ],
+            },
+            "rubricGroupKey": "A String", # Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation.
+          },
+        ],
+      },
+      "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.
+        "evaluationSet": "A String", # The evaluation set where item level results are stored.
+        "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run.
+          "failedItems": 42, # Optional. The number of items that failed to be evaluated.
+          "metrics": { # Optional. Map of metric name to metric value.
+            "a_key": "",
+          },
+          "totalItems": 42, # Optional. The total number of items that were evaluated.
+        },
+      },
+      "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.
+          "generationConfig": { # Generation config. # Optional. Generation config.
+            "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
+            "candidateCount": 42, # Optional. Number of candidates to generate.
+            "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
+            "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+            "logprobs": 42, # Optional. Logit probabilities.
+            "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+            "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+            "presencePenalty": 3.14, # Optional. Positive penalties.
+            "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
+            "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
+            "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+            "responseModalities": [ # Optional. The modalities of the response.
+              "A String",
+            ],
+            "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+              "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
+              "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
+                # Object with schema name: GoogleCloudAiplatformV1Schema
+              ],
+              "default": "", # Optional. Default value of the data.
+              "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "description": "A String", # Optional. The description of the data.
+              "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
+                "A String",
+              ],
+              "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+              "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+              "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+              "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+              "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+              "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+              "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+              "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+              "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+              "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+              "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+              "nullable": True or False, # Optional. Indicates if the value may be null.
+              "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+              "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
+                "A String",
+              ],
+              "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+              "required": [ # Optional. Required properties of Type.OBJECT.
+                "A String",
+              ],
+              "title": "A String", # Optional. The title of the Schema.
+              "type": "A String", # Optional. The type of the data.
+            },
+            "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
+              "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                "modelRoutingPreference": "A String", # The model routing preference.
+              },
+              "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
+                "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+              },
+            },
+            "seed": 42, # Optional. Seed.
+            "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+              "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+              "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+                "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+                  "voiceName": "A String", # The name of the preset voice to use.
+                },
+              },
+            },
+            "stopSequences": [ # Optional. Stop sequences.
+              "A String",
+            ],
+            "temperature": 3.14, # Optional. Controls the randomness of predictions.
+            "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+              "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
+              "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+            },
+            "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+            "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+          },
+          "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+        },
+      },
+      "labels": { # Optional. Labels for the evaluation run.
+        "a_key": "A String",
+      },
+      "metadata": "", # Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.
+      "name": "A String", # Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`
+      "state": "A String", # Output only. The state of the evaluation run.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html new file mode 100644 index 00000000000..c53aefb4b94 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html @@ -0,0 +1,295 @@ + + + +

Vertex AI API . projects . locations . evaluationSets

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an Evaluation Set.

+

+ delete(name, x__xgafv=None)

+

Deletes an Evaluation Set.

+

+ get(name, x__xgafv=None)

+

Gets an Evaluation Set.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Evaluation Sets.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an Evaluation Set.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an Evaluation Set.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EvaluationSet is a collection of related EvaluationItems that are evaluated together.
+  "createTime": "A String", # Output only. Timestamp when this item was created.
+  "displayName": "A String", # Required. The display name of the EvaluationSet.
+  "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset.
+    "A String",
+  ],
+  "metadata": "", # Optional. Metadata for the EvaluationSet.
+  "name": "A String", # Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+  "updateTime": "A String", # Output only. Timestamp when this item was last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationSet is a collection of related EvaluationItems that are evaluated together.
+  "createTime": "A String", # Output only. Timestamp when this item was created.
+  "displayName": "A String", # Required. The display name of the EvaluationSet.
+  "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset.
+    "A String",
+  ],
+  "metadata": "", # Optional. Metadata for the EvaluationSet.
+  "name": "A String", # Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+  "updateTime": "A String", # Output only. Timestamp when this item was last updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an Evaluation Set.
+
+Args:
+  name: string, Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an Evaluation Set.
+
+Args:
+  name: string, Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationSet is a collection of related EvaluationItems that are evaluated together.
+  "createTime": "A String", # Output only. Timestamp when this item was created.
+  "displayName": "A String", # Required. The display name of the EvaluationSet.
+  "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset.
+    "A String",
+  ],
+  "metadata": "", # Optional. Metadata for the EvaluationSet.
+  "name": "A String", # Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+  "updateTime": "A String", # Output only. Timestamp when this item was last updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Evaluation Sets.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
+  pageSize: integer, Optional. The maximum number of Evaluation Sets to return.
+  pageToken: string, Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for EvaluationManagementService.ListEvaluationSets.
+  "evaluationSets": [ # List of EvaluationSets in the requested page.
+    { # EvaluationSet is a collection of related EvaluationItems that are evaluated together.
+      "createTime": "A String", # Output only. Timestamp when this item was created.
+      "displayName": "A String", # Required. The display name of the EvaluationSet.
+      "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset.
+        "A String",
+      ],
+      "metadata": "", # Optional. Metadata for the EvaluationSet.
+      "name": "A String", # Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+      "updateTime": "A String", # Output only. Timestamp when this item was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates an Evaluation Set.
+
+Args:
+  name: string, Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EvaluationSet is a collection of related EvaluationItems that are evaluated together.
+  "createTime": "A String", # Output only. Timestamp when this item was created.
+  "displayName": "A String", # Required. The display name of the EvaluationSet.
+  "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset.
+    "A String",
+  ],
+  "metadata": "", # Optional. Metadata for the EvaluationSet.
+  "name": "A String", # Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+  "updateTime": "A String", # Output only. Timestamp when this item was last updated.
+}
+
+  updateMask: string, Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationSet is a collection of related EvaluationItems that are evaluated together.
+  "createTime": "A String", # Output only. Timestamp when this item was created.
+  "displayName": "A String", # Required. The display name of the EvaluationSet.
+  "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset.
+    "A String",
+  ],
+  "metadata": "", # Optional. Metadata for the EvaluationSet.
+  "name": "A String", # Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
+  "updateTime": "A String", # Output only. Timestamp when this item was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 237c4ca1753..e1324fb929f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -109,6 +109,21 @@

Instance Methods

Returns the endpoints Resource.

+

+ evaluationItems() +

+

Returns the evaluationItems Resource.

+ +

+ evaluationRuns() +

+

Returns the evaluationRuns Resource.

+ +

+ evaluationSets() +

+

Returns the evaluationSets Resource.

+

featureGroups()

@@ -265,6 +280,9 @@

Instance Methods

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

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.

get(name, x__xgafv=None)

Gets information about a location.

@@ -1732,8 +1750,17 @@

Method Details

}, "metricResults": [ # Metric results for each instance. The order of the metric results is guaranteed to be the same as the order of the instances in the request. { # Result for a single metric on a single instance. - "explanation": "A String", # The explanation for the metric result. - "rubricVerdicts": [ # For rubric-based metrics, the verdicts for each rubric. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error status for the metric result. + "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. + }, + "explanation": "A String", # Output only. The explanation for the metric result. + "rubricVerdicts": [ # Output only. For rubric-based metrics, the verdicts for each rubric. { # Represents the verdict of an evaluation against a single rubric. "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated. "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. @@ -1749,7 +1776,7 @@

Method Details

"verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". }, ], - "score": 3.14, # The score for the metric. Please refer to each metric's documentation for the meaning of the score. + "score": 3.14, # Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score. }, ], "metricxResult": { # Spec for MetricX result - calculates the MetricX score for the given instance using the version specified in the spec. # Result for Metricx metric. @@ -2017,6 +2044,149 @@

Method Details

} +
+ generateSyntheticData(location, body=None, x__xgafv=None) +
Generates synthetic data based on the provided configuration.
+
+Args:
+  location: string, Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for DataFoundryService.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.
+      "fields": [ # Required. A list of fields that constitute an example.
+        { # Represents a single named field within a SyntheticExample.
+          "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the field.
+            "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                  "outcome": "A String", # Required. Outcome of the code execution.
+                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                },
+                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                  "code": "A String", # Required. The code to be executed.
+                  "language": "A String", # Required. Programming language of the `code`.
+                },
+                "fileData": { # URI based data. # Optional. URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                  "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "text": "A String", # Optional. Text part (can be code).
+                "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "endOffset": "A String", # Optional. The end offset of the video.
+                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                  "startOffset": "A String", # Optional. The start offset of the video.
+                },
+              },
+            ],
+            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+          },
+          "fieldName": "A String", # Optional. The name of the field.
+        },
+      ],
+    },
+  ],
+  "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.
+      "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.
+    },
+  ],
+  "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.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+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.
+      "fields": [ # Required. A list of fields that constitute an example.
+        { # Represents a single named field within a SyntheticExample.
+          "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the field.
+            "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                  "outcome": "A String", # Required. Outcome of the code execution.
+                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                },
+                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                  "code": "A String", # Required. The code to be executed.
+                  "language": "A String", # Required. Programming language of the `code`.
+                },
+                "fileData": { # URI based data. # Optional. URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                  "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", # Required. The name of the function to call. Matches [FunctionDeclaration.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 output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "inlineData": { # Content blob. # Optional. Inlined bytes data.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "text": "A String", # Optional. Text part (can be code).
+                "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "endOffset": "A String", # Optional. The end offset of the video.
+                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                  "startOffset": "A String", # Optional. The start offset of the video.
+                },
+              },
+            ],
+            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+          },
+          "fieldName": "A String", # Optional. The name of the field.
+        },
+      ],
+    },
+  ],
+}
+
+
get(name, x__xgafv=None)
Gets information about a location.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
index ad70427756b..47efd6971ad 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
@@ -129,6 +129,9 @@ 

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -268,6 +271,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -349,6 +355,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -435,6 +444,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index 7116864cab2..389a4ccff45 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -123,6 +123,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -263,6 +266,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -344,6 +350,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -430,6 +439,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html index bc3d7e295a0..65341810955 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html @@ -523,6 +523,7 @@

Method Details

"requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, + "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. "displayName": "A String", # The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. "enableAccessLogging": True or False, # If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index c27806b555b..30b81327ec3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -735,6 +735,7 @@

Method Details

"requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, + "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. "displayName": "A String", # The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. "enableAccessLogging": True or False, # If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. @@ -1065,6 +1066,7 @@

Method Details

"requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, + "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. "displayName": "A String", # The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. "enableAccessLogging": True or False, # If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. @@ -2523,6 +2525,7 @@

Method Details

"requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, + "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. "displayName": "A String", # The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. "enableAccessLogging": True or False, # If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. @@ -2843,6 +2846,7 @@

Method Details

"requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, + "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. "displayName": "A String", # The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. "enableAccessLogging": True or False, # If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. @@ -3126,6 +3130,7 @@

Method Details

"requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, + "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. "displayName": "A String", # The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. "enableAccessLogging": True or False, # If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. @@ -3373,6 +3378,7 @@

Method Details

"requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, + "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. "displayName": "A String", # The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. "enableAccessLogging": True or False, # If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. @@ -3645,6 +3651,7 @@

Method Details

"requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, + "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. "displayName": "A String", # The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. "enableAccessLogging": True or False, # If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. @@ -5067,6 +5074,7 @@

Method Details

"requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). }, + "disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. "disableExplanations": True or False, # If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec. "displayName": "A String", # The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. "enableAccessLogging": True or False, # If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index a45ba7916b1..c22dfe7cea9 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -1917,8 +1917,17 @@

Method Details

}, "metricResults": [ # Metric results for each instance. The order of the metric results is guaranteed to be the same as the order of the instances in the request. { # Result for a single metric on a single instance. - "explanation": "A String", # The explanation for the metric result. - "rubricVerdicts": [ # For rubric-based metrics, the verdicts for each rubric. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error status for the metric result. + "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. + }, + "explanation": "A String", # Output only. The explanation for the metric result. + "rubricVerdicts": [ # Output only. For rubric-based metrics, the verdicts for each rubric. { # Represents the verdict of an evaluation against a single rubric. "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated. "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. @@ -1934,7 +1943,7 @@

Method Details

"verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". }, ], - "score": 3.14, # The score for the metric. Please refer to each metric's documentation for the meaning of the score. + "score": 3.14, # Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score. }, ], "metricxResult": { # Spec for MetricX result - calculates the MetricX score for the given instance using the version specified in the spec. # Result for Metricx metric. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index df4cf7fecef..fc80c1fba26 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -247,6 +247,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -485,6 +488,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -665,6 +671,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -850,6 +859,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index b3300c825e0..0088c38407d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -95,7 +95,7 @@

Instance Methods

get(name, x__xgafv=None)

Get a Memory.

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

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

List Memories.

list_next()

@@ -125,7 +125,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. @@ -327,7 +327,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. @@ -339,12 +339,13 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
List Memories.
 
 Args:
   parent: string, Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
   filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)
+  orderBy: string, Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`
   pageSize: integer, Optional. The standard list page size.
   pageToken: string, Optional. The standard list page token.
   x__xgafv: string, V1 error format.
@@ -361,7 +362,7 @@ 

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. @@ -402,7 +403,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. @@ -482,7 +483,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html index bfb55a75d79..35dfa1d353d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html @@ -118,20 +118,10 @@

Method Details

{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. "displayName": "A String", # Required. The display name of the SandboxEnvironment. - "metadata": "", # Output only. Additional information about the SandboxEnvironment. "name": "A String", # Identifier. The name of the SandboxEnvironment. "spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment. "codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment. "codeLanguage": "A String", # The coding language supported in this environment. - "dependencies": [ # Optional. The additional dependencies to install in the code execution environment. For example, "pandas==2.2.3". - "A String", - ], - "env": [ # Optional. The environment variables to set in the code execution environment. - { # Represents an environment variable present in a Container or Python Module. - "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier. - "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. - }, - ], "machineConfig": "A String", # The machine config of the code execution environment. }, }, @@ -266,20 +256,10 @@

Method Details

{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. "displayName": "A String", # Required. The display name of the SandboxEnvironment. - "metadata": "", # Output only. Additional information about the SandboxEnvironment. "name": "A String", # Identifier. The name of the SandboxEnvironment. "spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment. "codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment. "codeLanguage": "A String", # The coding language supported in this environment. - "dependencies": [ # Optional. The additional dependencies to install in the code execution environment. For example, "pandas==2.2.3". - "A String", - ], - "env": [ # Optional. The environment variables to set in the code execution environment. - { # Represents an environment variable present in a Container or Python Module. - "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier. - "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. - }, - ], "machineConfig": "A String", # The machine config of the code execution environment. }, }, @@ -311,20 +291,10 @@

Method Details

{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. "displayName": "A String", # Required. The display name of the SandboxEnvironment. - "metadata": "", # Output only. Additional information about the SandboxEnvironment. "name": "A String", # Identifier. The name of the SandboxEnvironment. "spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment. "codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment. "codeLanguage": "A String", # The coding language supported in this environment. - "dependencies": [ # Optional. The additional dependencies to install in the code execution environment. For example, "pandas==2.2.3". - "A String", - ], - "env": [ # Optional. The environment variables to set in the code execution environment. - { # Represents an environment variable present in a Container or Python Module. - "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier. - "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. - }, - ], "machineConfig": "A String", # The machine config of the code execution environment. }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index cf3119ce0a5..5af15df7597 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -312,6 +312,7 @@

Method Details

}, }, }, + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. "adapterSize": "A String", # Optional. Adapter size for preference optimization. "beta": 3.14, # Optional. Weight for KL Divergence regularization. @@ -1001,6 +1002,7 @@

Method Details

}, }, }, + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. "adapterSize": "A String", # Optional. Adapter size for preference optimization. "beta": 3.14, # Optional. Weight for KL Divergence regularization. @@ -1697,6 +1699,7 @@

Method Details

}, }, }, + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. "adapterSize": "A String", # Optional. Adapter size for preference optimization. "beta": 3.14, # Optional. Weight for KL Divergence regularization. @@ -2399,6 +2402,7 @@

Method Details

}, }, }, + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. "adapterSize": "A String", # Optional. Adapter size for preference optimization. "beta": 3.14, # Optional. Weight for KL Divergence regularization. @@ -3234,6 +3238,7 @@

Method Details

}, }, }, + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. "adapterSize": "A String", # Optional. Adapter size for preference optimization. "beta": 3.14, # Optional. Weight for KL Divergence regularization. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index 5991fa31b52..75fead300de 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -231,6 +231,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -470,6 +473,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -650,6 +656,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". @@ -835,6 +844,9 @@

Method Details

"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. }, "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + "labels": { # Labels for the ReasoningEngine. + "a_key": "A String", + }, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index 64fa4e179a8..f7d53e66596 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -90,7 +90,7 @@

Instance Methods

get(name, x__xgafv=None)

Get a Memory.

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

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

List Memories.

list_next()

@@ -120,7 +120,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. @@ -322,7 +322,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. @@ -334,12 +334,13 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
List Memories.
 
 Args:
   parent: string, Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
   filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)
+  orderBy: string, Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`
   pageSize: integer, Optional. The standard list page size.
   pageToken: string, Optional. The standard list page token.
   x__xgafv: string, V1 error format.
@@ -356,7 +357,7 @@ 

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. @@ -397,7 +398,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. @@ -477,7 +478,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. "displayName": "A String", # Optional. Display name of the Memory. - "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 05e3f101d9d..743e6bbb8cc 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -1294,6 +1294,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"generateSyntheticData": { +"description": "Generates synthetic data based on the provided configuration.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.generateSyntheticData", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+location}:generateSyntheticData", +"request": { +"$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets information about a location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", @@ -5094,6 +5122,452 @@ } } }, +"evaluationItems": { +"methods": { +"create": { +"description": "Creates an Evaluation Item.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.evaluationItems.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/evaluationItems", +"request": { +"$ref": "GoogleCloudAiplatformV1EvaluationItem" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1EvaluationItem" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an Evaluation Item.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.evaluationItems.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an Evaluation Item.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationItems.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1EvaluationItem" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Evaluation Items.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationItems.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of Evaluation Items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/evaluationItems", +"response": { +"$ref": "GoogleCloudAiplatformV1ListEvaluationItemsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"evaluationRuns": { +"methods": { +"cancel": { +"description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.evaluationRuns.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "GoogleCloudAiplatformV1CancelEvaluationRunRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates an Evaluation Run.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.evaluationRuns.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/evaluationRuns", +"request": { +"$ref": "GoogleCloudAiplatformV1EvaluationRun" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1EvaluationRun" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an Evaluation Run.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.evaluationRuns.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an Evaluation Run.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationRuns.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1EvaluationRun" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Evaluation Runs.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationRuns.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of Evaluation Runs to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/evaluationRuns", +"response": { +"$ref": "GoogleCloudAiplatformV1ListEvaluationRunsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"evaluationSets": { +"methods": { +"create": { +"description": "Creates an Evaluation Set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.evaluationSets.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/evaluationSets", +"request": { +"$ref": "GoogleCloudAiplatformV1EvaluationSet" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1EvaluationSet" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an Evaluation Set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.evaluationSets.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an Evaluation Set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationSets.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1EvaluationSet" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Evaluation Sets.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationSets.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of Evaluation Sets to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/evaluationSets", +"response": { +"$ref": "GoogleCloudAiplatformV1ListEvaluationSetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an Evaluation Set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.evaluationSets.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1EvaluationSet" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1EvaluationSet" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "featureGroups": { "methods": { "create": { @@ -20319,7 +20793,7 @@ } } }, -"revision": "20250825", +"revision": "20250902", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -22037,6 +22511,65 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1BigQueryRequestSet": { +"description": "The request set for the evaluation run.", +"id": "GoogleCloudAiplatformV1BigQueryRequestSet", +"properties": { +"candidateResponseColumns": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.", +"type": "object" +}, +"promptColumn": { +"description": "Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.", +"type": "string" +}, +"rubricsColumn": { +"description": "Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858).", +"type": "string" +}, +"samplingConfig": { +"$ref": "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig", +"description": "Optional. The sampling config for the bigquery resource." +}, +"uri": { +"description": "Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig": { +"description": "The sampling config.", +"id": "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig", +"properties": { +"samplingCount": { +"description": "Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100.", +"format": "int32", +"type": "integer" +}, +"samplingDuration": { +"description": "Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0.", +"format": "google-duration", +"type": "string" +}, +"samplingMethod": { +"description": "Optional. The sampling method to use.", +"enum": [ +"SAMPLING_METHOD_UNSPECIFIED", +"RANDOM" +], +"enumDescriptions": [ +"Unspecified sampling method.", +"Random sampling." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1BigQuerySource": { "description": "The BigQuery location for the input content.", "id": "GoogleCloudAiplatformV1BigQuerySource", @@ -22303,6 +22836,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudAiplatformV1CancelEvaluationRunRequest": { +"description": "Request message for EvaluationManagementService.CancelEvaluationRun.", +"id": "GoogleCloudAiplatformV1CancelEvaluationRunRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest": { "description": "Request message for JobService.CancelHyperparameterTuningJob.", "id": "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest", @@ -22388,13 +22927,13 @@ "Token generation stopped because the content contains forbidden terms.", "Token generation stopped for potentially containing prohibited content.", "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", -"The function call generated by the model is invalid.", +"The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).", "The model response was blocked by Model Armor.", "Token generation stopped because generated images has safety violations.", "Image generation stopped because generated images has other prohibited content.", "Image generation stopped due to recitation.", "Image generation stopped because of other miscellaneous issue.", -"The tool call generated by the model is invalid." +"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration)." ], "readOnly": true, "type": "string" @@ -22431,6 +22970,60 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1CandidateResponse": { +"description": "Responses from model or agent.", +"id": "GoogleCloudAiplatformV1CandidateResponse", +"properties": { +"candidate": { +"description": "Required. The name of the candidate that produced the response.", +"type": "string" +}, +"text": { +"description": "Text response.", +"type": "string" +}, +"value": { +"description": "Fields and values that can be used to populate the response template.", +"type": "any" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1CandidateResult": { +"description": "Result for a single candidate.", +"id": "GoogleCloudAiplatformV1CandidateResult", +"properties": { +"additionalResults": { +"description": "Optional. Additional results for the metric.", +"type": "any" +}, +"candidate": { +"description": "Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.", +"type": "string" +}, +"explanation": { +"description": "Optional. The explanation for the metric.", +"type": "string" +}, +"metric": { +"description": "Required. The metric that was evaluated.", +"type": "string" +}, +"rubricVerdicts": { +"description": "Optional. The rubric verdicts for the metric.", +"items": { +"$ref": "GoogleCloudAiplatformV1RubricVerdict" +}, +"type": "array" +}, +"score": { +"description": "Optional. The score for the metric.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata": { "description": "This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.", "id": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata", @@ -25817,6 +26410,639 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EvaluationItem": { +"description": "EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed.", +"id": "GoogleCloudAiplatformV1EvaluationItem", +"properties": { +"createTime": { +"description": "Output only. Timestamp when this item was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the EvaluationItem.", +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. Error for the evaluation item.", +"readOnly": true +}, +"evaluationItemType": { +"description": "Required. The type of the EvaluationItem.", +"enum": [ +"EVALUATION_ITEM_TYPE_UNSPECIFIED", +"REQUEST", +"RESULT" +], +"enumDescriptions": [ +"The default value. This value is unused.", +"The EvaluationItem is a request to evaluate.", +"The EvaluationItem is the result of evaluation." +], +"type": "string" +}, +"evaluationRequest": { +"$ref": "GoogleCloudAiplatformV1EvaluationRequest", +"description": "The request to evaluate." +}, +"evaluationResponse": { +"$ref": "GoogleCloudAiplatformV1EvaluationResult", +"description": "Output only. The response from evaluation.", +"readOnly": true +}, +"gcsUri": { +"description": "The GCS object where the request or response is stored.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels for the EvaluationItem.", +"type": "object" +}, +"metadata": { +"description": "Optional. Metadata for the EvaluationItem.", +"type": "any" +}, +"name": { +"description": "Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationPrompt": { +"description": "Prompt to be evaluated.", +"id": "GoogleCloudAiplatformV1EvaluationPrompt", +"properties": { +"promptTemplateData": { +"$ref": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData", +"description": "Prompt template data." +}, +"text": { +"description": "Text prompt.", +"type": "string" +}, +"value": { +"description": "Fields and values that can be used to populate the prompt template.", +"type": "any" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData": { +"description": "Message to hold a prompt template and the values to populate the template.", +"id": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData", +"properties": { +"values": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1Content" +}, +"description": "The values for fields in the prompt template.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRequest": { +"description": "Single evaluation request.", +"id": "GoogleCloudAiplatformV1EvaluationRequest", +"properties": { +"candidateResponses": { +"description": "Optional. Responses from model under test and other baseline models for comparison.", +"items": { +"$ref": "GoogleCloudAiplatformV1CandidateResponse" +}, +"type": "array" +}, +"goldenResponse": { +"$ref": "GoogleCloudAiplatformV1CandidateResponse", +"description": "Optional. The Ideal response or ground truth." +}, +"prompt": { +"$ref": "GoogleCloudAiplatformV1EvaluationPrompt", +"description": "Required. The request/prompt to evaluate." +}, +"rubrics": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1RubricGroup" +}, +"description": "Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationResult": { +"description": "Evaluation result.", +"id": "GoogleCloudAiplatformV1EvaluationResult", +"properties": { +"candidateResults": { +"description": "Optional. The results for the metric.", +"items": { +"$ref": "GoogleCloudAiplatformV1CandidateResult" +}, +"type": "array" +}, +"evaluationRequest": { +"description": "Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}", +"type": "string" +}, +"evaluationRun": { +"description": "Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}", +"type": "string" +}, +"metadata": { +"description": "Optional. Metadata about the evaluation result.", +"type": "any" +}, +"metric": { +"description": "Required. The metric that was evaluated.", +"type": "string" +}, +"request": { +"$ref": "GoogleCloudAiplatformV1EvaluationRequest", +"description": "Required. The request that was evaluated." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationResults": { +"description": "The results of the evaluation run.", +"id": "GoogleCloudAiplatformV1EvaluationResults", +"properties": { +"evaluationSet": { +"description": "The evaluation set where item level results are stored.", +"type": "string" +}, +"summaryMetrics": { +"$ref": "GoogleCloudAiplatformV1SummaryMetrics", +"description": "Optional. The summary metrics for the evaluation run." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRubricConfig": { +"description": "Configuration for a rubric group to be generated/saved for evaluation.", +"id": "GoogleCloudAiplatformV1EvaluationRubricConfig", +"properties": { +"predefinedRubricGenerationSpec": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", +"description": "Dynamically generate rubrics using a predefined spec." +}, +"rubricGenerationSpec": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", +"description": "Dynamically generate rubrics using this specification." +}, +"rubricGroupKey": { +"description": "Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRun": { +"description": "EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.", +"id": "GoogleCloudAiplatformV1EvaluationRun", +"properties": { +"completionTime": { +"description": "Output only. Time when the evaluation run was completed.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Time when the evaluation run was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataSource": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunDataSource", +"description": "Required. The data source for the evaluation run." +}, +"displayName": { +"description": "Required. The display name of the Evaluation Run.", +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.", +"readOnly": true +}, +"evaluationConfig": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig", +"description": "Required. The configuration used for the evaluation." +}, +"evaluationResults": { +"$ref": "GoogleCloudAiplatformV1EvaluationResults", +"description": "Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.", +"readOnly": true +}, +"evaluationSetSnapshot": { +"description": "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.", +"readOnly": true, +"type": "string" +}, +"inferenceConfigs": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunInferenceConfig" +}, +"description": "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.", +"type": "object" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels for the evaluation run.", +"type": "object" +}, +"metadata": { +"description": "Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.", +"type": "any" +}, +"name": { +"description": "Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", +"type": "string" +}, +"state": { +"description": "Output only. The state of the evaluation run.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED", +"CANCELLED", +"INFERENCE", +"GENERATING_RUBRICS" +], +"enumDescriptions": [ +"Unspecified state.", +"The evaluation run is pending.", +"The evaluation run is running.", +"The evaluation run has succeeded.", +"The evaluation run has failed.", +"The evaluation run has been cancelled.", +"The evaluation run is performing inference.", +"The evaluation run is performing rubric generation." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunDataSource": { +"description": "The data source for the evaluation run.", +"id": "GoogleCloudAiplatformV1EvaluationRunDataSource", +"properties": { +"bigqueryRequestSet": { +"$ref": "GoogleCloudAiplatformV1BigQueryRequestSet", +"description": "Evaluation data in bigquery." +}, +"evaluationSet": { +"description": "The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunEvaluationConfig": { +"description": "The Evalution configuration used for the evaluation run.", +"id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig", +"properties": { +"autoraterConfig": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", +"description": "Optional. The autorater config for the evaluation run." +}, +"metrics": { +"description": "Required. The metrics to be calculated in the evaluation run.", +"items": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetric" +}, +"type": "array" +}, +"outputConfig": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig", +"description": "Optional. The output config for the evaluation run." +}, +"promptTemplate": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate", +"description": "The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values." +}, +"rubricConfigs": { +"description": "Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation.", +"items": { +"$ref": "GoogleCloudAiplatformV1EvaluationRubricConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig": { +"description": "The autorater config used for the evaluation run.", +"id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", +"properties": { +"autoraterModel": { +"description": "Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"type": "string" +}, +"generationConfig": { +"$ref": "GoogleCloudAiplatformV1GenerationConfig", +"description": "Optional. Configuration options for model generation and outputs." +}, +"sampleCount": { +"description": "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.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig": { +"description": "The output config for the evaluation run.", +"id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig", +"properties": { +"bigqueryDestination": { +"$ref": "GoogleCloudAiplatformV1BigQueryDestination", +"description": "BigQuery destination for evaluation output." +}, +"gcsDestination": { +"$ref": "GoogleCloudAiplatformV1GcsDestination", +"description": "Cloud Storage destination for evaluation output." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate": { +"description": "Prompt template used for inference.", +"id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate", +"properties": { +"gcsUri": { +"description": "Prompt template stored in Cloud Storage. Format: \"gs://my-bucket/file-name.txt\".", +"type": "string" +}, +"promptTemplate": { +"description": "Inline prompt template. Template variables should be in the format \"{var_name}\". Example: \"Translate the following from {source_lang} to {target_lang}: {text}\"", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunInferenceConfig": { +"description": "An inference config used for model inference during the evaluation run.", +"id": "GoogleCloudAiplatformV1EvaluationRunInferenceConfig", +"properties": { +"generationConfig": { +"$ref": "GoogleCloudAiplatformV1GenerationConfig", +"description": "Optional. Generation config." +}, +"model": { +"description": "Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunMetric": { +"description": "The metric used for evaluation runs.", +"id": "GoogleCloudAiplatformV1EvaluationRunMetric", +"properties": { +"computationBasedMetricSpec": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec", +"description": "Spec for a computation based metric." +}, +"llmBasedMetricSpec": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec", +"description": "Spec for an LLM based metric." +}, +"metric": { +"description": "Required. The name of the metric.", +"type": "string" +}, +"predefinedMetricSpec": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", +"description": "Spec for a pre-defined metric." +}, +"rubricBasedMetricSpec": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec", +"description": "Spec for rubric based metric." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec": { +"description": "Specification for a computation based metric.", +"id": "GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec", +"properties": { +"parameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. A map of parameters for the metric, e.g. {\"rouge_type\": \"rougeL\"}.", +"type": "object" +}, +"type": { +"description": "Required. The type of the computation based metric.", +"enum": [ +"COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED", +"EXACT_MATCH", +"BLEU", +"ROUGE" +], +"enumDescriptions": [ +"Unspecified computation based metric type.", +"Exact match metric.", +"BLEU metric.", +"ROUGE metric." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec": { +"description": "Specification for an LLM based metric.", +"id": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec", +"properties": { +"additionalConfig": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Optional additional configuration for the metric.", +"type": "object" +}, +"judgeAutoraterConfig": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", +"description": "Optional. Optional configuration for the judge LLM (Autorater)." +}, +"metricPromptTemplate": { +"description": "Required. Template for the prompt sent to the judge model.", +"type": "string" +}, +"predefinedRubricGenerationSpec": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", +"description": "Dynamically generate rubrics using a predefined spec." +}, +"rubricGenerationSpec": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", +"description": "Dynamically generate rubrics using this specification." +}, +"rubricGroupKey": { +"description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.", +"type": "string" +}, +"systemInstruction": { +"description": "Optional. System instructions for the judge model.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec": { +"description": "Specification for a pre-defined metric.", +"id": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", +"properties": { +"metricSpecName": { +"description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\".", +"type": "string" +}, +"parameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The parameters needed to run the pre-defined metric.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec": { +"description": "Specification for a metric that is based on rubrics.", +"id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec", +"properties": { +"inlineRubrics": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", +"description": "Use rubrics provided directly in the spec." +}, +"judgeAutoraterConfig": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", +"description": "Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided." +}, +"metricPromptTemplate": { +"description": "Optional. Template for the prompt used by the judge model to evaluate against rubrics.", +"type": "string" +}, +"rubricGenerationSpec": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", +"description": "Dynamically generate rubrics for evaluation using this specification." +}, +"rubricGroupKey": { +"description": "Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics": { +"description": "Defines a list of rubrics, used when providing rubrics inline.", +"id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", +"properties": { +"rubrics": { +"description": "The list of rubrics.", +"items": { +"$ref": "GoogleCloudAiplatformV1Rubric" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec": { +"description": "Specification for how rubrics should be generated.", +"id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", +"properties": { +"modelConfig": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", +"description": "Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation." +}, +"promptTemplate": { +"description": "Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.", +"type": "string" +}, +"rubricContentType": { +"description": "Optional. The type of rubric content to be generated.", +"enum": [ +"RUBRIC_CONTENT_TYPE_UNSPECIFIED", +"PROPERTY", +"NL_QUESTION_ANSWER", +"PYTHON_CODE_ASSERTION" +], +"enumDescriptions": [ +"The content type to generate is not specified.", +"Generate rubrics based on properties.", +"Generate rubrics in an NL question answer format.", +"Generate rubrics in a unit test format." +], +"type": "string" +}, +"rubricTypeOntology": { +"description": "Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationSet": { +"description": "EvaluationSet is a collection of related EvaluationItems that are evaluated together.", +"id": "GoogleCloudAiplatformV1EvaluationSet", +"properties": { +"createTime": { +"description": "Output only. Timestamp when this item was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the EvaluationSet.", +"type": "string" +}, +"evaluationItems": { +"description": "Required. The EvaluationItems that are part of this dataset.", +"items": { +"type": "string" +}, +"type": "array" +}, +"metadata": { +"description": "Optional. Metadata for the EvaluationSet.", +"type": "any" +}, +"name": { +"description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when this item was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1Event": { "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", "id": "GoogleCloudAiplatformV1Event", @@ -29004,6 +30230,50 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1GenerateSyntheticDataRequest": { +"description": "Request message for DataFoundryService.GenerateSyntheticData.", +"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.", +"format": "int32", +"type": "integer" +}, +"examples": { +"description": "Optional. A list of few-shot examples to guide the model's output style and format.", +"items": { +"$ref": "GoogleCloudAiplatformV1SyntheticExample" +}, +"type": "array" +}, +"outputFieldSpecs": { +"description": "Required. The schema of the desired output, defined by a list of fields.", +"items": { +"$ref": "GoogleCloudAiplatformV1OutputFieldSpec" +}, +"type": "array" +}, +"taskDescription": { +"$ref": "GoogleCloudAiplatformV1TaskDescriptionStrategy", +"description": "Generate data from a high-level task description." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1GenerateSyntheticDataResponse": { +"description": "The response containing the generated data.", +"id": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse", +"properties": { +"syntheticExamples": { +"description": "A list of generated synthetic examples.", +"items": { +"$ref": "GoogleCloudAiplatformV1SyntheticExample" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1GenerateVideoResponse": { "description": "Generate video response.", "id": "GoogleCloudAiplatformV1GenerateVideoResponse", @@ -30858,6 +32128,60 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1ListEvaluationItemsResponse": { +"description": "Response message for EvaluationManagementService.ListEvaluationItems.", +"id": "GoogleCloudAiplatformV1ListEvaluationItemsResponse", +"properties": { +"evaluationItems": { +"description": "List of EvaluationItems in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1EvaluationItem" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1ListEvaluationRunsResponse": { +"description": "Response message for EvaluationManagementService.ListEvaluationRuns.", +"id": "GoogleCloudAiplatformV1ListEvaluationRunsResponse", +"properties": { +"evaluationRuns": { +"description": "List of EvaluationRuns in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1EvaluationRun" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1ListEvaluationSetsResponse": { +"description": "Response message for EvaluationManagementService.ListEvaluationSets.", +"id": "GoogleCloudAiplatformV1ListEvaluationSetsResponse", +"properties": { +"evaluationSets": { +"description": "List of EvaluationSets in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1EvaluationSet" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ListExecutionsResponse": { "description": "Response message for MetadataService.ListExecutions.", "id": "GoogleCloudAiplatformV1ListExecutionsResponse", @@ -31983,20 +33307,28 @@ false "description": "Result for a single metric on a single instance.", "id": "GoogleCloudAiplatformV1MetricResult", "properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error status for the metric result.", +"readOnly": true +}, "explanation": { -"description": "The explanation for the metric result.", +"description": "Output only. The explanation for the metric result.", +"readOnly": true, "type": "string" }, "rubricVerdicts": { -"description": "For rubric-based metrics, the verdicts for each rubric.", +"description": "Output only. For rubric-based metrics, the verdicts for each rubric.", "items": { "$ref": "GoogleCloudAiplatformV1RubricVerdict" }, +"readOnly": true, "type": "array" }, "score": { -"description": "The score for the metric. Please refer to each metric's documentation for the meaning of the score.", +"description": "Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.", "format": "float", +"readOnly": true, "type": "number" } }, @@ -34933,6 +36265,39 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1OutputFieldSpec": { +"description": "Defines a specification for a single output field.", +"id": "GoogleCloudAiplatformV1OutputFieldSpec", +"properties": { +"fieldName": { +"description": "Required. The name of the output field.", +"type": "string" +}, +"fieldType": { +"description": "Optional. The data type of the field. Defaults to CONTENT if not set.", +"enum": [ +"FIELD_TYPE_UNSPECIFIED", +"CONTENT", +"TEXT", +"IMAGE", +"AUDIO" +], +"enumDescriptions": [ +"Field type is unspecified.", +"Arbitrary content field type.", +"Text field type.", +"Image field type.", +"Audio field type." +], +"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.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1PSCAutomationConfig": { "description": "PSC config that is used to automatically create PSC endpoints in the user projects.", "id": "GoogleCloudAiplatformV1PSCAutomationConfig", @@ -38241,6 +39606,13 @@ false "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels for the ReasoningEngine.", +"type": "object" +}, "name": { "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" @@ -45342,6 +46714,30 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1SummaryMetrics": { +"description": "The summary metrics for the evaluation run.", +"id": "GoogleCloudAiplatformV1SummaryMetrics", +"properties": { +"failedItems": { +"description": "Optional. The number of items that failed to be evaluated.", +"format": "int32", +"type": "integer" +}, +"metrics": { +"additionalProperties": { +"type": "any" +}, +"description": "Optional. Map of metric name to metric value.", +"type": "object" +}, +"totalItems": { +"description": "Optional. The total number of items that were evaluated.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1SupervisedHyperParameters": { "description": "Hyperparameters for SFT.", "id": "GoogleCloudAiplatformV1SupervisedHyperParameters", @@ -45593,6 +46989,35 @@ 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.", +"id": "GoogleCloudAiplatformV1SyntheticExample", +"properties": { +"fields": { +"description": "Required. A list of fields that constitute an example.", +"items": { +"$ref": "GoogleCloudAiplatformV1SyntheticField" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SyntheticField": { +"description": "Represents a single named field within a SyntheticExample.", +"id": "GoogleCloudAiplatformV1SyntheticField", +"properties": { +"content": { +"$ref": "GoogleCloudAiplatformV1Content", +"description": "Required. The content of the field." +}, +"fieldName": { +"description": "Optional. The name of the field.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1TFRecordDestination": { "description": "The storage details for TFRecord output content.", "id": "GoogleCloudAiplatformV1TFRecordDestination", @@ -45604,6 +47029,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1TaskDescriptionStrategy": { +"description": "Defines a generation strategy based on a high-level task description.", +"id": "GoogleCloudAiplatformV1TaskDescriptionStrategy", +"properties": { +"taskDescription": { +"description": "Required. A high-level description of the synthetic data to be generated.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1Tensor": { "description": "A tensor value type.", "id": "GoogleCloudAiplatformV1Tensor", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index b001d7c722e..ebba728d36c 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -20231,6 +20231,11 @@ "location": "query", "type": "string" }, +"orderBy": { +"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", +"location": "query", +"type": "string" +}, "pageSize": { "description": "Optional. The standard list page size.", "format": "int32", @@ -25695,6 +25700,11 @@ "location": "query", "type": "string" }, +"orderBy": { +"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", +"location": "query", +"type": "string" +}, "pageSize": { "description": "Optional. The standard list page size.", "format": "int32", @@ -26026,7 +26036,7 @@ } } }, -"revision": "20250825", +"revision": "20250902", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -28431,13 +28441,13 @@ "Token generation stopped because the content contains forbidden terms.", "Token generation stopped for potentially containing prohibited content.", "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", -"The function call generated by the model is invalid.", +"The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).", "The model response was blocked by Model Armor.", "Token generation stopped because generated images has safety violations.", "Image generation stopped because generated images has other prohibited content.", "Image generation stopped due to recitation.", "Image generation stopped because of other miscellaneous issue.", -"The tool call generated by the model is invalid." +"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration)." ], "readOnly": true, "type": "string" @@ -31109,6 +31119,10 @@ "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources", "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration." }, +"disableContainerLogging": { +"description": "For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.", +"type": "boolean" +}, "disableExplanations": { "description": "If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec.", "type": "boolean" @@ -40634,7 +40648,7 @@ false "type": "string" }, "expireTime": { -"description": "Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.", +"description": "Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.", "format": "google-datetime", "type": "string" }, @@ -41011,20 +41025,28 @@ false "description": "Result for a single metric on a single instance.", "id": "GoogleCloudAiplatformV1beta1MetricResult", "properties": { +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error status for the metric result.", +"readOnly": true +}, "explanation": { -"description": "The explanation for the metric result.", +"description": "Output only. The explanation for the metric result.", +"readOnly": true, "type": "string" }, "rubricVerdicts": { -"description": "For rubric-based metrics, the verdicts for each rubric.", +"description": "Output only. For rubric-based metrics, the verdicts for each rubric.", "items": { "$ref": "GoogleCloudAiplatformV1beta1RubricVerdict" }, +"readOnly": true, "type": "array" }, "score": { -"description": "The score for the metric. Please refer to each metric's documentation for the meaning of the score.", +"description": "Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.", "format": "float", +"readOnly": true, "type": "number" } }, @@ -46378,6 +46400,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1EvaluationConfig", "description": "Optional. Evaluation Config for Preference Optimization Job." }, +"exportLastCheckpointOnly": { +"description": "Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.", +"type": "boolean" +}, "hyperParameters": { "$ref": "GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters", "description": "Optional. Hyperparameters for Preference Optimization." @@ -48834,6 +48860,13 @@ false "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels for the ReasoningEngine.", +"type": "object" +}, "name": { "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" @@ -50507,11 +50540,6 @@ false "description": "Required. The display name of the SandboxEnvironment.", "type": "string" }, -"metadata": { -"description": "Output only. Additional information about the SandboxEnvironment.", -"readOnly": true, -"type": "any" -}, "name": { "description": "Identifier. The name of the SandboxEnvironment.", "type": "string" @@ -50579,20 +50607,6 @@ false ], "type": "string" }, -"dependencies": { -"description": "Optional. The additional dependencies to install in the code execution environment. For example, \"pandas==2.2.3\".", -"items": { -"type": "string" -}, -"type": "array" -}, -"env": { -"description": "Optional. The environment variables to set in the code execution environment.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1EnvVar" -}, -"type": "array" -}, "machineConfig": { "description": "The machine config of the code execution environment.", "enum": [ @@ -59992,12 +60006,14 @@ false "enum": [ "TUNING_TASK_UNSPECIFIED", "TUNING_TASK_I2V", -"TUNING_TASK_T2V" +"TUNING_TASK_T2V", +"TUNING_TASK_R2V" ], "enumDescriptions": [ "Default value. This value is unused.", "Tuning task for image to video.", -"Tuning task for text to video." +"Tuning task for text to video.", +"Tuning task for reference to video." ], "type": "string" } From 67b3e55e7b36b6cdfdc324483ef019cb8c9072e4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 03/27] feat(analyticshub): update the api #### analyticshub:v1 The following keys were added: - schemas.BigQueryDatasetSource.properties.effectiveReplicas (Total Keys: 3) - schemas.BigQueryDatasetSource.properties.replicaLocations (Total Keys: 2) - schemas.DestinationDataset.properties.replicaLocations (Total Keys: 2) - schemas.Replica (Total Keys: 8) #### analyticshub:v1beta1 The following keys were added: - schemas.DestinationDataset.properties.replicaLocations (Total Keys: 2) --- ...b_v1.projects.locations.dataExchanges.html | 6 ++ ...ects.locations.dataExchanges.listings.html | 69 +++++++++++++++++++ ...b_v1.projects.locations.subscriptions.html | 6 ++ .../documents/analyticshub.v1.json | 64 ++++++++++++++++- .../documents/analyticshub.v1beta1.json | 9 ++- 5 files changed, 152 insertions(+), 2 deletions(-) diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html index 0a6132b6bed..bbd430460bd 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html @@ -378,6 +378,9 @@

Method Details

"a_key": "A String", }, "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "replicaLocations": [ # Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. + "A String", + ], }, "lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified. "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. @@ -601,6 +604,9 @@

Method Details

"a_key": "A String", }, "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "replicaLocations": [ # Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. + "A String", + ], }, "subscriberContact": "A String", # Email of the subscriber. "subscription": "A String", # Required. Name of the subscription to create. e.g. `subscription1` diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html index 9e1f3348b26..ef329a79139 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html @@ -132,6 +132,16 @@

Method Details

"allowOnlyMetadataSharing": True or False, # Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Shared dataset i.e. BigQuery dataset source. "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "effectiveReplicas": [ # Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation. + { # Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica. + "location": "A String", # Output only. The geographic location where the replica resides. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. Eg. "us-central1". + "primaryState": "A String", # Output only. Indicates that this replica is the primary replica. + "replicaState": "A String", # Output only. Assigned by Analytics Hub based on real BigQuery replication state. + }, + ], + "replicaLocations": [ # Optional. A list of regions where the publisher has created shared dataset replicas. + "A String", + ], "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -198,6 +208,16 @@

Method Details

"allowOnlyMetadataSharing": True or False, # Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Shared dataset i.e. BigQuery dataset source. "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "effectiveReplicas": [ # Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation. + { # Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica. + "location": "A String", # Output only. The geographic location where the replica resides. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. Eg. "us-central1". + "primaryState": "A String", # Output only. Indicates that this replica is the primary replica. + "replicaState": "A String", # Output only. Assigned by Analytics Hub based on real BigQuery replication state. + }, + ], + "replicaLocations": [ # Optional. A list of regions where the publisher has created shared dataset replicas. + "A String", + ], "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -289,6 +309,16 @@

Method Details

"allowOnlyMetadataSharing": True or False, # Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Shared dataset i.e. BigQuery dataset source. "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "effectiveReplicas": [ # Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation. + { # Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica. + "location": "A String", # Output only. The geographic location where the replica resides. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. Eg. "us-central1". + "primaryState": "A String", # Output only. Indicates that this replica is the primary replica. + "replicaState": "A String", # Output only. Assigned by Analytics Hub based on real BigQuery replication state. + }, + ], + "replicaLocations": [ # Optional. A list of regions where the publisher has created shared dataset replicas. + "A String", + ], "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -421,6 +451,16 @@

Method Details

"allowOnlyMetadataSharing": True or False, # Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Shared dataset i.e. BigQuery dataset source. "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "effectiveReplicas": [ # Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation. + { # Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica. + "location": "A String", # Output only. The geographic location where the replica resides. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. Eg. "us-central1". + "primaryState": "A String", # Output only. Indicates that this replica is the primary replica. + "replicaState": "A String", # Output only. Assigned by Analytics Hub based on real BigQuery replication state. + }, + ], + "replicaLocations": [ # Optional. A list of regions where the publisher has created shared dataset replicas. + "A String", + ], "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -517,6 +557,9 @@

Method Details

"a_key": "A String", }, "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "replicaLocations": [ # Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. + "A String", + ], }, "lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified. "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. @@ -587,6 +630,16 @@

Method Details

"allowOnlyMetadataSharing": True or False, # Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Shared dataset i.e. BigQuery dataset source. "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "effectiveReplicas": [ # Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation. + { # Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica. + "location": "A String", # Output only. The geographic location where the replica resides. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. Eg. "us-central1". + "primaryState": "A String", # Output only. Indicates that this replica is the primary replica. + "replicaState": "A String", # Output only. Assigned by Analytics Hub based on real BigQuery replication state. + }, + ], + "replicaLocations": [ # Optional. A list of regions where the publisher has created shared dataset replicas. + "A String", + ], "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -653,6 +706,16 @@

Method Details

"allowOnlyMetadataSharing": True or False, # Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable. "bigqueryDataset": { # A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. # Shared dataset i.e. BigQuery dataset source. "dataset": "A String", # Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + "effectiveReplicas": [ # Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation. + { # Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica. + "location": "A String", # Output only. The geographic location where the replica resides. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. Eg. "us-central1". + "primaryState": "A String", # Output only. Indicates that this replica is the primary replica. + "replicaState": "A String", # Output only. Assigned by Analytics Hub based on real BigQuery replication state. + }, + ], + "replicaLocations": [ # Optional. A list of regions where the publisher has created shared dataset replicas. + "A String", + ], "restrictedExportPolicy": { # Restricted export policy used to configure restricted export on linked dataset. # Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. "enabled": True or False, # Optional. If true, enable restricted export. "restrictDirectTableAccess": True or False, # Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. @@ -813,6 +876,9 @@

Method Details

"a_key": "A String", }, "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "replicaLocations": [ # Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. + "A String", + ], }, "destinationPubsubSubscription": { # Defines the destination Pub/Sub subscription. # Input only. Destination Pub/Sub subscription to create for the subscriber. "pubsubSubscription": { # Defines the destination Pub/Sub subscription. If none of `push_config`, `bigquery_config`, `cloud_storage_config`, `pubsub_export_config`, or `pubsublite_export_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. # Required. Destination Pub/Sub subscription resource. @@ -919,6 +985,9 @@

Method Details

"a_key": "A String", }, "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "replicaLocations": [ # Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. + "A String", + ], }, "lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified. "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. diff --git a/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html b/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html index 8d41798fdd8..294515338a6 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html +++ b/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html @@ -175,6 +175,9 @@

Method Details

"a_key": "A String", }, "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "replicaLocations": [ # Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. + "A String", + ], }, "lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified. "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. @@ -297,6 +300,9 @@

Method Details

"a_key": "A String", }, "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + "replicaLocations": [ # Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. + "A String", + ], }, "lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified. "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index 4367aeb7eea..845647c5df1 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1247,7 +1247,7 @@ } } }, -"revision": "20250807", +"revision": "20250901", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "ApproveQueryTemplateRequest": { @@ -1358,6 +1358,21 @@ "description": "Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", "type": "string" }, +"effectiveReplicas": { +"description": "Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation.", +"items": { +"$ref": "Replica" +}, +"readOnly": true, +"type": "array" +}, +"replicaLocations": { +"description": "Optional. A list of regions where the publisher has created shared dataset replicas.", +"items": { +"type": "string" +}, +"type": "array" +}, "restrictedExportPolicy": { "$ref": "RestrictedExportPolicy", "description": "Optional. If set, restricted export policy will be propagated and enforced on the linked dataset." @@ -1585,6 +1600,13 @@ "location": { "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", "type": "string" +}, +"replicaLocations": { +"description": "Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -2438,6 +2460,46 @@ }, "type": "object" }, +"Replica": { +"description": "Represents the state of a replica of a shared dataset. It includes the geographic location of the replica and system-computed, output-only fields indicating its replication state and whether it is the primary replica.", +"id": "Replica", +"properties": { +"location": { +"description": "Output only. The geographic location where the replica resides. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations. Eg. \"us-central1\".", +"readOnly": true, +"type": "string" +}, +"primaryState": { +"description": "Output only. Indicates that this replica is the primary replica.", +"enum": [ +"PRIMARY_STATE_UNSPECIFIED", +"PRIMARY_REPLICA" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The replica is the primary replica." +], +"readOnly": true, +"type": "string" +}, +"replicaState": { +"description": "Output only. Assigned by Analytics Hub based on real BigQuery replication state.", +"enum": [ +"REPLICA_STATE_UNSPECIFIED", +"READY_TO_USE", +"UNAVAILABLE" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The replica is backfilled and ready to use.", +"The replica is unavailable, does not exist, or has not been backfilled yet." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "RestrictedExportConfig": { "description": "Restricted export config, used to configure restricted export on linked dataset.", "id": "RestrictedExportConfig", diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json index d63847725a7..2677d9ca625 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json @@ -695,7 +695,7 @@ } } }, -"revision": "20250623", +"revision": "20250901", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -871,6 +871,13 @@ "location": { "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", "type": "string" +}, +"replicaLocations": { +"description": "Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From 2e9b68d8cf6ec0075a73c5e4592aaa27e0d38ced Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 04/27] feat(androidpublisher): update the api #### androidpublisher:v3 The following keys were added: - resources.purchases.resources.subscriptionsv2.methods.cancel (Total Keys: 14) - schemas.AutoRenewingPlan.properties.priceStepUpConsentDetails.$ref (Total Keys: 1) - schemas.CancelSubscriptionPurchaseRequest (Total Keys: 3) - schemas.CancelSubscriptionPurchaseResponse (Total Keys: 2) - schemas.CancellationContext (Total Keys: 3) - schemas.PriceStepUpConsentDetails (Total Keys: 7) --- ...ublisher_v3.purchases.subscriptionsv2.html | 40 +++++++ .../documents/androidpublisher.v3.json | 111 +++++++++++++++++- 2 files changed, 150 insertions(+), 1 deletion(-) diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html index a999e6ebe90..aa0722c9bf4 100644 --- a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html +++ b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html @@ -74,6 +74,9 @@

Google Play Android Developer API . purchases . subscriptionsv2

Instance Methods

+

+ cancel(packageName, token, body=None, x__xgafv=None)

+

Cancel a subscription purchase for the user.

close()

Close httplib2 connections.

@@ -84,6 +87,34 @@

Instance Methods

revoke(packageName, token, body=None, x__xgafv=None)

Revoke a subscription purchase for the user.

Method Details

+
+ cancel(packageName, token, body=None, x__xgafv=None) +
Cancel a subscription purchase for the user.
+
+Args:
+  packageName: string, Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
+  token: string, Required. The token provided to the user's device when the subscription was purchased. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the purchases.subscriptionsv2.cancel API.
+  "cancellationContext": { # Cancellation context of the purchases.subscriptionsv2.cancel API. # Required. Additional details around the subscription revocation.
+    "cancellationType": "A String", # Required. The type of cancellation for the purchased subscription.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the purchases.subscriptionsv2.cancel API.
+}
+
+
close()
Close httplib2 connections.
@@ -149,6 +180,15 @@

Method Details

"priceChangeMode": "A String", # Price change mode specifies how the subscription item price is changing. "priceChangeState": "A String", # State the price change is currently in. }, + "priceStepUpConsentDetails": { # Information related to a price step-up that requires user consent. # The information of the latest price step-up consent. + "consentDeadlineTime": "A String", # The deadline by which the user must provide consent. If consent is not provided by this time, the subscription will be canceled. + "newPrice": { # Represents an amount of money with its currency type. # The new price which requires user consent. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, + "state": "A String", # Output only. The state of the price step-up consent. + }, "recurringPrice": { # Represents an amount of money with its currency type. # The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes for tax-exclusive pricing, please call orders.get API instead if transaction details are needed. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 18f019fcb7c..a2233540634 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -4985,6 +4985,40 @@ }, "subscriptionsv2": { "methods": { +"cancel": { +"description": "Cancel a subscription purchase for the user.", +"flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel", +"httpMethod": "POST", +"id": "androidpublisher.purchases.subscriptionsv2.cancel", +"parameterOrder": [ +"packageName", +"token" +], +"parameters": { +"packageName": { +"description": "Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing').", +"location": "path", +"required": true, +"type": "string" +}, +"token": { +"description": "Required. The token provided to the user's device when the subscription was purchased.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel", +"request": { +"$ref": "CancelSubscriptionPurchaseRequest" +}, +"response": { +"$ref": "CancelSubscriptionPurchaseResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] +}, "get": { "description": "Get metadata about a subscription", "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}", @@ -5521,7 +5555,7 @@ } } }, -"revision": "20250828", +"revision": "20250904", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6174,6 +6208,10 @@ "$ref": "SubscriptionItemPriceChangeDetails", "description": "The information of the last price change for the item since subscription signup." }, +"priceStepUpConsentDetails": { +"$ref": "PriceStepUpConsentDetails", +"description": "The information of the latest price step-up consent." +}, "recurringPrice": { "$ref": "Money", "description": "The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes for tax-exclusive pricing, please call orders.get API instead if transaction details are needed." @@ -6736,6 +6774,23 @@ }, "type": "object" }, +"CancelSubscriptionPurchaseRequest": { +"description": "Request for the purchases.subscriptionsv2.cancel API.", +"id": "CancelSubscriptionPurchaseRequest", +"properties": { +"cancellationContext": { +"$ref": "CancellationContext", +"description": "Required. Additional details around the subscription revocation." +} +}, +"type": "object" +}, +"CancelSubscriptionPurchaseResponse": { +"description": "Response for the purchases.subscriptionsv2.cancel API.", +"id": "CancelSubscriptionPurchaseResponse", +"properties": {}, +"type": "object" +}, "CancelSurveyResult": { "description": "Result of the cancel survey when the subscription was canceled by the user.", "id": "CancelSurveyResult", @@ -6790,6 +6845,27 @@ }, "type": "object" }, +"CancellationContext": { +"description": "Cancellation context of the purchases.subscriptionsv2.cancel API.", +"id": "CancellationContext", +"properties": { +"cancellationType": { +"description": "Required. The type of cancellation for the purchased subscription.", +"enum": [ +"CANCELLATION_TYPE_UNSPECIFIED", +"USER_REQUESTED_STOP_RENEWALS", +"DEVELOPER_REQUESTED_STOP_PAYMENTS" +], +"enumDescriptions": [ +"Cancellation type unspecified.", +"Cancellation requested by the user, and the subscription can be restored. It only stops the subscription's next renewal. For an installment subscription, users still need to finish the commitment period. For more details on renewals and payments, see https://developer.android.com/google/play/billing/subscriptions#installments", +"Cancellation requested by the developer, and the subscription cannot be restored. It stops the subscription's next payment. For an installment subscription, users will not need to pay the next payment and finish the commitment period. For more details on renewals and payments, see https://developer.android.com/google/play/billing/subscriptions#installments" +], +"type": "string" +} +}, +"type": "object" +}, "CancellationEvent": { "description": "Details of when the order was canceled.", "id": "CancellationEvent", @@ -9831,6 +9907,39 @@ false }, "type": "object" }, +"PriceStepUpConsentDetails": { +"description": "Information related to a price step-up that requires user consent.", +"id": "PriceStepUpConsentDetails", +"properties": { +"consentDeadlineTime": { +"description": "The deadline by which the user must provide consent. If consent is not provided by this time, the subscription will be canceled.", +"format": "google-datetime", +"type": "string" +}, +"newPrice": { +"$ref": "Money", +"description": "The new price which requires user consent." +}, +"state": { +"description": "Output only. The state of the price step-up consent.", +"enum": [ +"CONSENT_STATE_UNSPECIFIED", +"PENDING", +"CONFIRMED", +"COMPLETED" +], +"enumDescriptions": [ +"Unspecified consent state.", +"The user has not yet provided consent.", +"The user has consented, and the new price is waiting to take effect.", +"The user has consented, and the new price has taken effect." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ProcessedEvent": { "description": "Details of when the order was processed.", "id": "ProcessedEvent", From e77e2707a7947e9412299ed8499490f002a2bd25 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 05/27] feat(cloudcommerceprocurement): update the api #### cloudcommerceprocurement:v1 The following keys were added: - schemas.Account.properties.inputProperties.deprecated (Total Keys: 1) --- docs/dyn/cloudcommerceprocurement_v1.html | 22 +- ...erceprocurement_v1.providers.accounts.html | 42 +- ...procurement_v1.providers.entitlements.html | 121 +- .../cloudcommerceprocurement.v1.json | 1808 +++++++++-------- 4 files changed, 1039 insertions(+), 954 deletions(-) diff --git a/docs/dyn/cloudcommerceprocurement_v1.html b/docs/dyn/cloudcommerceprocurement_v1.html index 034452a4a5b..45c192ef4a6 100644 --- a/docs/dyn/cloudcommerceprocurement_v1.html +++ b/docs/dyn/cloudcommerceprocurement_v1.html @@ -95,17 +95,17 @@

Method Details

new_batch_http_request()
Create a BatchHttpRequest object based on the discovery document.
 
-        Args:
-          callback: callable, A callback to be called for each response, of the
-            form callback(id, response, exception). The first parameter is the
-            request id, and the second is the deserialized response object. The
-            third is an apiclient.errors.HttpError exception object if an HTTP
-            error occurred while processing the request, or None if no error
-            occurred.
-
-        Returns:
-          A BatchHttpRequest object based on the discovery document.
-        
+ Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. +
\ No newline at end of file diff --git a/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html index 6f84bcc6734..7451a8c79a0 100644 --- a/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html +++ b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html @@ -87,21 +87,21 @@

Instance Methods

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists Accounts that the provider has access to.

- list_next(previous_request, previous_response)

+ list_next()

Retrieves the next page of results.

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

Rejects an approval on an Account.

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

-

Resets an Account and cancel all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.

+

Resets an Account and cancels all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.

Method Details

approve(name, body=None, x__xgafv=None)
Grants an approval on an Account.
 
 Args:
-  name: string, The resource name of the account. Required. (required)
+  name: string, Required. The resource name of the account, with the format `providers/{providerId}/accounts/{accountId}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -121,7 +121,7 @@ 

Method Details

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); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
@@ -135,7 +135,7 @@

Method Details

Gets a requested Account resource.
 
 Args:
-  name: string, The name of the account to retrieve. (required)
+  name: string, Required. The name of the account to retrieve. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -169,8 +169,8 @@ 

Method Details

Lists Accounts that the provider has access to.
 
 Args:
-  parent: string, The parent resource name. (required)
-  pageSize: integer, The maximum number of entries that are requested. Default size is 200.
+  parent: string, Required. The parent resource name. (required)
+  pageSize: integer, The maximum number of entries that are requested. The default page size is 25 and the maximum page size is 200.
   pageToken: string, The token for fetching the next page.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -206,17 +206,17 @@ 

Method Details

- list_next(previous_request, previous_response) + 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)
+        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.
-    
+ 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. +
@@ -224,7 +224,7 @@

Method Details

Rejects an approval on an Account.
 
 Args:
-  name: string, The resource name of the account. Required. (required)
+  name: string, Required. The resource name of the account. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -241,20 +241,20 @@ 

Method Details

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); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
reset(name, body=None, x__xgafv=None) -
Resets an Account and cancel all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.
+  
Resets an Account and cancels all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.
 
 Args:
-  name: string, The resource name of the account. Required. (required)
+  name: string, Required. The resource name of the account. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for for PartnerProcurementService.ResetAccount.
+{ # Request message for PartnerProcurementService.ResetAccount.
 }
 
   x__xgafv: string, V1 error format.
@@ -265,7 +265,7 @@ 

Method Details

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); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }
diff --git a/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html b/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html index b7a241c086a..7563527fff5 100644 --- a/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html +++ b/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html @@ -90,7 +90,7 @@

Instance Methods

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists Entitlements for which the provider has read access.

- list_next(previous_request, previous_response)

+ list_next()

Retrieves the next page of results.

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

@@ -110,11 +110,12 @@

Method Details

Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.
 
 Args:
-  name: string, The resource name of the entitlement. Required. (required)
+  name: string, Required. The resource name of the entitlement, with the format `providers/{providerId}/entitlements/{entitlementId}`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for [PartnerProcurementService.ApproveEntitlement[].
+  "entitlementMigrated": "A String", # Optional. The resource name of the entitlement that was migrated, with the format `providers/{provider_id}/entitlements/{entitlement_id}`. Should only be sent when resources have been migrated from entitlement_migrated to the new entitlement. Optional.
   "properties": { # Set of properties that should be associated with the entitlement. Optional.
     "a_key": "A String",
   },
@@ -128,7 +129,7 @@ 

Method Details

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); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
@@ -137,12 +138,12 @@

Method Details

Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.
 
 Args:
-  name: string, The resource name of the entitlement. Required. (required)
+  name: string, Required. The resource name of the entitlement. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[].
-  "pendingPlanName": "A String", # Name of the pending plan that is being approved. Required.
+  "pendingPlanName": "A String", # Required. Name of the pending plan that's being approved.
 }
 
   x__xgafv: string, V1 error format.
@@ -153,7 +154,7 @@ 

Method Details

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); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
@@ -167,7 +168,7 @@

Method Details

Gets a requested Entitlement resource.
 
 Args:
-  name: string, The name of the entitlement to retrieve. (required)
+  name: string, Required. The name of the entitlement to retrieve. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,25 +177,34 @@ 

Method Details

Returns: An object of the form: - { # Represents a procured product of a customer. Next Id: 23 + { # Represents a procured product of a customer. "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any. + "cancellationReason": "A String", # Output only. The reason the entitlement was cancelled. If this entitlement wasn't cancelled, this field is empty. Possible values include "unknown", "expired", "user-cancelled", "account-closed", "billing-disabled" (if the customer has manually disabled billing to their resources), "user-aborted", and "migrated" (if the entitlement has migrated across products). Values of this field are subject to change, and we recommend that you don't build your technical integration to rely on these fields. "consumers": [ # Output only. The resources using this entitlement, if applicable. { # A resource using (consuming) this entitlement. "project": "A String", # A project name with format `projects/`. }, ], "createTime": "A String", # Output only. The creation timestamp. + "entitlementBenefitIds": [ # Output only. The entitlement benefit IDs associated with the purchase. + "A String", + ], "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement. "a_key": "", # Properties of the object. }, "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes. "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`. - "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. + "newOfferEndTime": "A String", # Output only. The end time of the new offer. If the offer was created with a term instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is be empty. + "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. + "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. + "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was created with a specified end date instead of a duration, this field is empty. "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. - "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. + "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. + "offerDuration": "A String", # Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer was created with a specified end date instead of a duration, this field is empty. "offerEndTime": "A String", # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer. + "orderId": "A String", # Output only. The order ID of this entitlement, without any `orders/` resource name prefix. "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans. - "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. + "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer. "productExternalName": "A String", # Output only. The identifier of the product that was procured. "provider": "A String", # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. @@ -210,9 +220,9 @@

Method Details

Lists Entitlements for which the provider has read access.
 
 Args:
-  parent: string, The parent resource name. (required)
-  filter: string, The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `consumers.project` Note that the consumers match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. Also note that the state name match is case-insensitive and query can omit the prefix "ENTITLEMENT_". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product="providerId:productId"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.
-  pageSize: integer, The maximum number of entries that are requested.
+  parent: string, Required. The parent resource name. (required)
+  filter: string, The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `services` * `consumers.project` * `change_history.new_offer` Note that the consumers and change_history.new_offer match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. `change_history.new_offer` retrieves all entitlements that were once associated or are currently active with the offer. Also note that the state name match is case-insensitive and query can omit the prefix "ENTITLEMENT_". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product="providerId:productId"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.
+  pageSize: integer, The maximum number of entries that are requested. The default page size is 200.
   pageToken: string, The token for fetching the next page.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -224,25 +234,34 @@ 

Method Details

{ # Response message for PartnerProcurementService.ListEntitlements. "entitlements": [ # The list of entitlements in this response. - { # Represents a procured product of a customer. Next Id: 23 + { # Represents a procured product of a customer. "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any. + "cancellationReason": "A String", # Output only. The reason the entitlement was cancelled. If this entitlement wasn't cancelled, this field is empty. Possible values include "unknown", "expired", "user-cancelled", "account-closed", "billing-disabled" (if the customer has manually disabled billing to their resources), "user-aborted", and "migrated" (if the entitlement has migrated across products). Values of this field are subject to change, and we recommend that you don't build your technical integration to rely on these fields. "consumers": [ # Output only. The resources using this entitlement, if applicable. { # A resource using (consuming) this entitlement. "project": "A String", # A project name with format `projects/`. }, ], "createTime": "A String", # Output only. The creation timestamp. + "entitlementBenefitIds": [ # Output only. The entitlement benefit IDs associated with the purchase. + "A String", + ], "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement. "a_key": "", # Properties of the object. }, "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes. "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`. - "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. + "newOfferEndTime": "A String", # Output only. The end time of the new offer. If the offer was created with a term instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is be empty. + "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. + "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. + "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was created with a specified end date instead of a duration, this field is empty. "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. - "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. + "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. + "offerDuration": "A String", # Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer was created with a specified end date instead of a duration, this field is empty. "offerEndTime": "A String", # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer. + "orderId": "A String", # Output only. The order ID of this entitlement, without any `orders/` resource name prefix. "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans. - "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. + "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer. "productExternalName": "A String", # Output only. The identifier of the product that was procured. "provider": "A String", # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. @@ -257,17 +276,17 @@

Method Details

- list_next(previous_request, previous_response) + 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)
+        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.
-    
+ 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. +
@@ -275,29 +294,38 @@

Method Details

Updates an existing Entitlement.
 
 Args:
-  name: string, The name of the entitlement to update. (required)
+  name: string, Required. The name of the entitlement to update. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a procured product of a customer. Next Id: 23
+{ # Represents a procured product of a customer.
   "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any.
+  "cancellationReason": "A String", # Output only. The reason the entitlement was cancelled. If this entitlement wasn't cancelled, this field is empty. Possible values include "unknown", "expired", "user-cancelled", "account-closed", "billing-disabled" (if the customer has manually disabled billing to their resources), "user-aborted", and "migrated" (if the entitlement has migrated across products). Values of this field are subject to change, and we recommend that you don't build your technical integration to rely on these fields.
   "consumers": [ # Output only. The resources using this entitlement, if applicable.
     { # A resource using (consuming) this entitlement.
       "project": "A String", # A project name with format `projects/`.
     },
   ],
   "createTime": "A String", # Output only. The creation timestamp.
+  "entitlementBenefitIds": [ # Output only. The entitlement benefit IDs associated with the purchase.
+    "A String",
+  ],
   "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement.
     "a_key": "", # Properties of the object.
   },
   "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
   "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
-  "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+  "newOfferEndTime": "A String", # Output only. The end time of the new offer. If the offer was created with a term instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is be empty.
+  "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty.
+  "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part.
+  "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was created with a specified end date instead of a duration, this field is empty.
   "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
-  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
+  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part.
+  "offerDuration": "A String", # Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer was created with a specified end date instead of a duration, this field is empty.
   "offerEndTime": "A String", # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
+  "orderId": "A String", # Output only. The order ID of this entitlement, without any `orders/` resource name prefix.
   "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans.
-  "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.
+  "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer.
   "productExternalName": "A String", # Output only. The identifier of the product that was procured.
   "provider": "A String", # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
   "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.
@@ -316,25 +344,34 @@ 

Method Details

Returns: An object of the form: - { # Represents a procured product of a customer. Next Id: 23 + { # Represents a procured product of a customer. "account": "A String", # Output only. The resource name of the account that this entitlement is based on, if any. + "cancellationReason": "A String", # Output only. The reason the entitlement was cancelled. If this entitlement wasn't cancelled, this field is empty. Possible values include "unknown", "expired", "user-cancelled", "account-closed", "billing-disabled" (if the customer has manually disabled billing to their resources), "user-aborted", and "migrated" (if the entitlement has migrated across products). Values of this field are subject to change, and we recommend that you don't build your technical integration to rely on these fields. "consumers": [ # Output only. The resources using this entitlement, if applicable. { # A resource using (consuming) this entitlement. "project": "A String", # A project name with format `projects/`. }, ], "createTime": "A String", # Output only. The creation timestamp. + "entitlementBenefitIds": [ # Output only. The entitlement benefit IDs associated with the purchase. + "A String", + ], "inputProperties": { # Output only. The custom properties that were collected from the user to create this entitlement. "a_key": "", # Properties of the object. }, "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes. "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`. - "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. + "newOfferEndTime": "A String", # Output only. The end time of the new offer. If the offer was created with a term instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is be empty. + "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. + "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. + "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was created with a specified end date instead of a duration, this field is empty. "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. - "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. + "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. + "offerDuration": "A String", # Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer was created with a specified end date instead of a duration, this field is empty. "offerEndTime": "A String", # Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer. + "orderId": "A String", # Output only. The order ID of this entitlement, without any `orders/` resource name prefix. "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans. - "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. + "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer. "productExternalName": "A String", # Output only. The identifier of the product that was procured. "provider": "A String", # Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. "quoteExternalName": "A String", # Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote. @@ -350,7 +387,7 @@

Method Details

Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.
 
 Args:
-  name: string, The resource name of the entitlement. Required. (required)
+  name: string, Required. The resource name of the entitlement. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -366,7 +403,7 @@ 

Method Details

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); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
@@ -375,12 +412,12 @@

Method Details

Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.
 
 Args:
-  name: string, The resource name of the entitlement. Required. (required)
+  name: string, Required. The resource name of the entitlement. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for PartnerProcurementService.RejectEntitlementPlanChange.
-  "pendingPlanName": "A String", # Name of the pending plan that is being rejected. Required.
+  "pendingPlanName": "A String", # Required. Name of the pending plan that is being rejected.
   "reason": "A String", # Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.
 }
 
@@ -392,7 +429,7 @@ 

Method Details

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); } The JSON representation for `Empty` is empty JSON object `{}`. + { # 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); } }
@@ -401,7 +438,7 @@

Method Details

Requests suspension of an active Entitlement. This is not yet supported.
 
 Args:
-  name: string, The name of the entitlement to suspend. (required)
+  name: string, Required. The name of the entitlement to suspend. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -417,7 +454,7 @@ 

Method Details

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); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }
diff --git a/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json index 11c978f50d2..eeadb8acd64 100644 --- a/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json @@ -1,882 +1,930 @@ { - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "See, edit, configure, and delete your Google Cloud Platform data" - } - } - } - }, - "basePath": "", - "baseUrl": "https://cloudcommerceprocurement.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Cloud Commerce Partner Procurement Service", - "description": "Partner API for the Cloud Commerce Procurement Service.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/marketplace/docs/partners/", - "fullyEncodeReservedExpansion": true, - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "cloudcommerceprocurement:v1", - "kind": "discovery#restDescription", - "mtlsRootUrl": "https://cloudcommerceprocurement.mtls.googleapis.com/", - "name": "cloudcommerceprocurement", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "description": "Data format for response.", - "enum": [ - "json", - "media", - "proto" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ], - "location": "query", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", - "location": "query", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "providers": { - "resources": { - "accounts": { - "methods": { - "approve": { - "description": "Grants an approval on an Account.", - "flatPath": "v1/providers/{providersId}/accounts/{accountsId}:approve", - "httpMethod": "POST", - "id": "cloudcommerceprocurement.providers.accounts.approve", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the account. Required.", - "location": "path", - "pattern": "^providers/[^/]+/accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:approve", - "request": { - "$ref": "ApproveAccountRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a requested Account resource.", - "flatPath": "v1/providers/{providersId}/accounts/{accountsId}", - "httpMethod": "GET", - "id": "cloudcommerceprocurement.providers.accounts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the account to retrieve.", - "location": "path", - "pattern": "^providers/[^/]+/accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Account" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Accounts that the provider has access to.", - "flatPath": "v1/providers/{providersId}/accounts", - "httpMethod": "GET", - "id": "cloudcommerceprocurement.providers.accounts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of entries that are requested. Default size is 200.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The token for fetching the next page.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The parent resource name.", - "location": "path", - "pattern": "^providers/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/accounts", - "response": { - "$ref": "ListAccountsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "reject": { - "description": "Rejects an approval on an Account.", - "flatPath": "v1/providers/{providersId}/accounts/{accountsId}:reject", - "httpMethod": "POST", - "id": "cloudcommerceprocurement.providers.accounts.reject", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the account. Required.", - "location": "path", - "pattern": "^providers/[^/]+/accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:reject", - "request": { - "$ref": "RejectAccountRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "reset": { - "description": "Resets an Account and cancel all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.", - "flatPath": "v1/providers/{providersId}/accounts/{accountsId}:reset", - "httpMethod": "POST", - "id": "cloudcommerceprocurement.providers.accounts.reset", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the account. Required.", - "location": "path", - "pattern": "^providers/[^/]+/accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:reset", - "request": { - "$ref": "ResetAccountRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "entitlements": { - "methods": { - "approve": { - "description": "Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.", - "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:approve", - "httpMethod": "POST", - "id": "cloudcommerceprocurement.providers.entitlements.approve", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the entitlement. Required.", - "location": "path", - "pattern": "^providers/[^/]+/entitlements/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:approve", - "request": { - "$ref": "ApproveEntitlementRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "approvePlanChange": { - "description": "Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.", - "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange", - "httpMethod": "POST", - "id": "cloudcommerceprocurement.providers.entitlements.approvePlanChange", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the entitlement. Required.", - "location": "path", - "pattern": "^providers/[^/]+/entitlements/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:approvePlanChange", - "request": { - "$ref": "ApproveEntitlementPlanChangeRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a requested Entitlement resource.", - "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}", - "httpMethod": "GET", - "id": "cloudcommerceprocurement.providers.entitlements.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the entitlement to retrieve.", - "location": "path", - "pattern": "^providers/[^/]+/entitlements/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Entitlement" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Entitlements for which the provider has read access.", - "flatPath": "v1/providers/{providersId}/entitlements", - "httpMethod": "GET", - "id": "cloudcommerceprocurement.providers.entitlements.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `consumers.project` Note that the consumers match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. Also note that the state name match is case-insensitive and query can omit the prefix \"ENTITLEMENT_\". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product=\"providerId:productId\"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of entries that are requested.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The token for fetching the next page.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The parent resource name.", - "location": "path", - "pattern": "^providers/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/entitlements", - "response": { - "$ref": "ListEntitlementsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates an existing Entitlement.", - "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}", - "httpMethod": "PATCH", - "id": "cloudcommerceprocurement.providers.entitlements.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the entitlement to update.", - "location": "path", - "pattern": "^providers/[^/]+/entitlements/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) for more details.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "Entitlement" - }, - "response": { - "$ref": "Entitlement" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "reject": { - "description": "Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.", - "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:reject", - "httpMethod": "POST", - "id": "cloudcommerceprocurement.providers.entitlements.reject", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the entitlement. Required.", - "location": "path", - "pattern": "^providers/[^/]+/entitlements/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:reject", - "request": { - "$ref": "RejectEntitlementRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "rejectPlanChange": { - "description": "Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.", - "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange", - "httpMethod": "POST", - "id": "cloudcommerceprocurement.providers.entitlements.rejectPlanChange", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the entitlement. Required.", - "location": "path", - "pattern": "^providers/[^/]+/entitlements/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:rejectPlanChange", - "request": { - "$ref": "RejectEntitlementPlanChangeRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "suspend": { - "description": "Requests suspension of an active Entitlement. This is not yet supported.", - "flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:suspend", - "httpMethod": "POST", - "id": "cloudcommerceprocurement.providers.entitlements.suspend", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the entitlement to suspend.", - "location": "path", - "pattern": "^providers/[^/]+/entitlements/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:suspend", - "request": { - "$ref": "SuspendEntitlementRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - }, - "revision": "20210410", - "rootUrl": "https://cloudcommerceprocurement.googleapis.com/", - "schemas": { - "Account": { - "description": "Represents an account that was established by the customer on the service provider's system.", - "id": "Account", - "properties": { - "approvals": { - "description": "Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened.", - "items": { - "$ref": "Approval" - }, - "type": "array" - }, - "createTime": { - "description": "Output only. The creation timestamp.", - "format": "google-datetime", - "type": "string" - }, - "inputProperties": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Output only. The custom properties that were collected from the user to create this account.", - "type": "object" - }, - "name": { - "description": "Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.", - "type": "string" - }, - "provider": { - "description": "Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.", - "type": "string" - }, - "state": { - "description": "Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.", - "enum": [ - "ACCOUNT_STATE_UNSPECIFIED", - "ACCOUNT_ACTIVATION_REQUESTED", - "ACCOUNT_ACTIVE" - ], - "enumDescriptions": [ - "Default state of the account. It's only set to this value when the account is first created and has not been initialized.", - "The customer has requested the creation of the account resource, and the provider notification message is dispatched. This state has been deprecated, as accounts now immediately transition to AccountState.ACCOUNT_ACTIVE.", - "The account is active and ready for use. The next possible states are: - Account getting deleted: After the user invokes delete from another API." - ], - "type": "string" - }, - "updateTime": { - "description": "Output only. The last update timestamp.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "Approval": { - "description": "An approval for some action on an account.", - "id": "Approval", - "properties": { - "name": { - "description": "Output only. The name of the approval.", - "type": "string" - }, - "reason": { - "description": "Output only. An explanation for the state of the approval.", - "type": "string" - }, - "state": { - "description": "Output only. The state of the approval.", - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "APPROVED", - "REJECTED" - ], - "enumDescriptions": [ - "Sentinel value; do not use.", - "The approval is pending response from the provider. The approval state can transition to Account.Approval.State.APPROVED or Account.Approval.State.REJECTED.", - "The approval has been granted by the provider.", - "The approval has been rejected by the provider. A provider may choose to approve a previously rejected approval, so is it possible to transition to Account.Approval.State.APPROVED." - ], - "type": "string" - }, - "updateTime": { - "description": "Optional. The last update timestamp of the approval.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "ApproveAccountRequest": { - "description": "Request message for PartnerProcurementService.ApproveAccount.", - "id": "ApproveAccountRequest", - "properties": { - "approvalName": { - "description": "The name of the approval being approved. If absent and there is only one approval possible, that approval will be granted. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.", - "type": "string" - }, - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Set of properties that should be associated with the account. Optional.", - "type": "object" - }, - "reason": { - "description": "Free form text string explaining the approval reason. Optional. Max allowed length: 256 bytes. Longer strings will be truncated.", - "type": "string" - } - }, - "type": "object" - }, - "ApproveEntitlementPlanChangeRequest": { - "description": "Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[].", - "id": "ApproveEntitlementPlanChangeRequest", - "properties": { - "pendingPlanName": { - "description": "Name of the pending plan that is being approved. Required.", - "type": "string" - } - }, - "type": "object" - }, - "ApproveEntitlementRequest": { - "description": "Request message for [PartnerProcurementService.ApproveEntitlement[].", - "id": "ApproveEntitlementRequest", - "properties": { - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Set of properties that should be associated with the entitlement. Optional.", - "type": "object" - } - }, - "type": "object" - }, - "Consumer": { - "description": "A resource using (consuming) this entitlement.", - "id": "Consumer", - "properties": { - "project": { - "description": "A project name with format `projects/`.", - "type": "string" - } - }, - "type": "object" - }, - "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "Entitlement": { - "description": "Represents a procured product of a customer. Next Id: 23", - "id": "Entitlement", - "properties": { - "account": { - "description": "Output only. The resource name of the account that this entitlement is based on, if any.", - "type": "string" - }, - "consumers": { - "description": "Output only. The resources using this entitlement, if applicable.", - "items": { - "$ref": "Consumer" - }, - "type": "array" - }, - "createTime": { - "description": "Output only. The creation timestamp.", - "format": "google-datetime", - "type": "string" - }, - "inputProperties": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Output only. The custom properties that were collected from the user to create this entitlement.", - "type": "object" - }, - "messageToUser": { - "description": "Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.", - "type": "string" - }, - "name": { - "description": "Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.", - "type": "string" - }, - "newPendingOffer": { - "description": "Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.", - "readOnly": true, - "type": "string" - }, - "newPendingPlan": { - "description": "Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.", - "type": "string" - }, - "offer": { - "description": "Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.", - "readOnly": true, - "type": "string" - }, - "offerEndTime": { - "description": "Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "plan": { - "description": "Output only. The identifier of the plan that was procured. Required if the product has plans.", - "type": "string" - }, - "product": { - "description": "Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer.", - "type": "string" - }, - "productExternalName": { - "description": "Output only. The identifier of the product that was procured.", - "readOnly": true, - "type": "string" - }, - "provider": { - "description": "Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.", - "type": "string" - }, - "quoteExternalName": { - "description": "Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.", - "readOnly": true, - "type": "string" - }, - "state": { - "description": "Output only. The state of the entitlement.", - "enum": [ - "ENTITLEMENT_STATE_UNSPECIFIED", - "ENTITLEMENT_ACTIVATION_REQUESTED", - "ENTITLEMENT_ACTIVE", - "ENTITLEMENT_PENDING_CANCELLATION", - "ENTITLEMENT_CANCELLED", - "ENTITLEMENT_PENDING_PLAN_CHANGE", - "ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL", - "ENTITLEMENT_SUSPENDED" - ], - "enumDescriptions": [ - "Default state of the entitlement. It's only set to this value when the entitlement is first created and has not been initialized.", - "Indicates that the entitlement is being created and the backend has sent a notification to the provider for the activation approval. If the provider approves, then the entitlement will transition to the EntitlementState.ENTITLEMENT_ACTIVE state. Otherwise, the entitlement will be removed. Plan changes are not allowed in this state. Instead the entitlement is cancelled and re-created with a new plan name.", - "Indicates that the entitlement is active. The procured item is now usable and any associated billing events will start occurring. In this state, the customer can decide to cancel the entitlement, which would change the state to EntitlementState.ENTITLEMENT_PENDING_CANCELLATION, and then EntitlementState.ENTITLEMENT_CANCELLED. The user can also request a change of plan, which will transition the state to EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE, and then back to EntitlementState.ENTITLEMENT_ACTIVE.", - "Indicates that the entitlement was cancelled by the customer. The entitlement typically stays in this state if the entitlement/plan allows use of the underlying resource until the end of the current billing cycle. Once the billing cycle completes, the resource will transition to EntitlementState.ENTITLEMENT_CANCELLED state. The resource cannot be modified during this state.", - "Indicates that the entitlement was cancelled. The entitlement can now be deleted.", - "Indicates that the entitlement is currently active, but there is a pending plan change that is requested by the customer. The entitlement typically stays in this state, if the entitlement/plan requires the completion of the current billing cycle before the plan can be changed. Once the billing cycle completes, the resource will transition to EntitlementState.ENTITLEMENT_ACTIVE, with its plan changed.", - "Indicates that the entitlement is currently active, but there is a plan change request pending provider approval. If the provider approves the plan change, then the entitlement will transition either to EntitlementState.ENTITLEMENT_ACTIVE or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE depending on whether current plan requires that the billing cycle completes. If the provider rejects the plan change, then the pending plan change request is removed and the entitlement stays in EntitlementState.ENTITLEMENT_ACTIVE state with the old plan.", - "Indicates that the entitlement is suspended either by Google or provider request. This can be triggered for various external reasons (e.g. expiration of credit card on the billing account, violation of terms-of-service of the provider etc.). As such, any remediating action needs to be taken externally, before the entitlement can be activated. This is not yet supported." - ], - "type": "string" - }, - "subscriptionEndTime": { - "description": "Output only. End time for the subscription corresponding to this entitlement.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "updateTime": { - "description": "Output only. The last update timestamp.", - "format": "google-datetime", - "type": "string" - }, - "usageReportingId": { - "description": "Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.", - "type": "string" - } - }, - "type": "object" - }, - "ListAccountsResponse": { - "description": "Response message for [PartnerProcurementService.ListAccounts[].", - "id": "ListAccountsResponse", - "properties": { - "accounts": { - "description": "The list of accounts in this response.", - "items": { - "$ref": "Account" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The token for fetching the next page.", - "type": "string" - } - }, - "type": "object" - }, - "ListEntitlementsResponse": { - "description": "Response message for PartnerProcurementService.ListEntitlements.", - "id": "ListEntitlementsResponse", - "properties": { - "entitlements": { - "description": "The list of entitlements in this response.", - "items": { - "$ref": "Entitlement" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The token for fetching the next page.", - "type": "string" - } - }, - "type": "object" - }, - "RejectAccountRequest": { - "description": "Request message for PartnerProcurementService.RejectAccount.", - "id": "RejectAccountRequest", - "properties": { - "approvalName": { - "description": "The name of the approval being rejected. If absent and there is only one approval possible, that approval will be rejected. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.", - "type": "string" - }, - "reason": { - "description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", - "type": "string" - } - }, - "type": "object" - }, - "RejectEntitlementPlanChangeRequest": { - "description": "Request message for PartnerProcurementService.RejectEntitlementPlanChange.", - "id": "RejectEntitlementPlanChangeRequest", - "properties": { - "pendingPlanName": { - "description": "Name of the pending plan that is being rejected. Required.", - "type": "string" - }, - "reason": { - "description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", - "type": "string" - } - }, - "type": "object" - }, - "RejectEntitlementRequest": { - "description": "Request message for PartnerProcurementService.RejectEntitlement.", - "id": "RejectEntitlementRequest", - "properties": { - "reason": { - "description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", - "type": "string" - } - }, - "type": "object" - }, - "ResetAccountRequest": { - "description": "Request message for for PartnerProcurementService.ResetAccount.", - "id": "ResetAccountRequest", - "properties": {}, - "type": "object" - }, - "SuspendEntitlementRequest": { - "description": "Request message for ParterProcurementService.SuspendEntitlement. This is not yet supported.", - "id": "SuspendEntitlementRequest", - "properties": { - "reason": { - "description": "A free-form reason string, explaining the reason for suspension request.", - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud Commerce Partner Procurement API", - "version": "v1", - "version_module": true +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://cloudcommerceprocurement.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Cloud Commerce Partner Procurement Service", +"description": "Partner API for the Cloud Commerce Procurement Service.", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/marketplace/docs/partners/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "cloudcommerceprocurement:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://cloudcommerceprocurement.mtls.googleapis.com/", +"name": "cloudcommerceprocurement", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"providers": { +"resources": { +"accounts": { +"methods": { +"approve": { +"description": "Grants an approval on an Account.", +"flatPath": "v1/providers/{providersId}/accounts/{accountsId}:approve", +"httpMethod": "POST", +"id": "cloudcommerceprocurement.providers.accounts.approve", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the account, with the format `providers/{providerId}/accounts/{accountId}`.", +"location": "path", +"pattern": "^providers/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:approve", +"request": { +"$ref": "ApproveAccountRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a requested Account resource.", +"flatPath": "v1/providers/{providersId}/accounts/{accountsId}", +"httpMethod": "GET", +"id": "cloudcommerceprocurement.providers.accounts.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the account to retrieve.", +"location": "path", +"pattern": "^providers/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Account" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Accounts that the provider has access to.", +"flatPath": "v1/providers/{providersId}/accounts", +"httpMethod": "GET", +"id": "cloudcommerceprocurement.providers.accounts.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of entries that are requested. The default page size is 25 and the maximum page size is 200.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The token for fetching the next page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name.", +"location": "path", +"pattern": "^providers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/accounts", +"response": { +"$ref": "ListAccountsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"reject": { +"description": "Rejects an approval on an Account.", +"flatPath": "v1/providers/{providersId}/accounts/{accountsId}:reject", +"httpMethod": "POST", +"id": "cloudcommerceprocurement.providers.accounts.reject", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the account.", +"location": "path", +"pattern": "^providers/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:reject", +"request": { +"$ref": "RejectAccountRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"reset": { +"description": "Resets an Account and cancels all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.", +"flatPath": "v1/providers/{providersId}/accounts/{accountsId}:reset", +"httpMethod": "POST", +"id": "cloudcommerceprocurement.providers.accounts.reset", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the account.", +"location": "path", +"pattern": "^providers/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:reset", +"request": { +"$ref": "ResetAccountRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"entitlements": { +"methods": { +"approve": { +"description": "Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to approve the creation of the entitlement resource.", +"flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:approve", +"httpMethod": "POST", +"id": "cloudcommerceprocurement.providers.entitlements.approve", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the entitlement, with the format `providers/{providerId}/entitlements/{entitlementId}`.", +"location": "path", +"pattern": "^providers/[^/]+/entitlements/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:approve", +"request": { +"$ref": "ApproveEntitlementRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"approvePlanChange": { +"description": "Approves an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to approve the plan change on the entitlement resource.", +"flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange", +"httpMethod": "POST", +"id": "cloudcommerceprocurement.providers.entitlements.approvePlanChange", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the entitlement.", +"location": "path", +"pattern": "^providers/[^/]+/entitlements/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:approvePlanChange", +"request": { +"$ref": "ApproveEntitlementPlanChangeRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a requested Entitlement resource.", +"flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}", +"httpMethod": "GET", +"id": "cloudcommerceprocurement.providers.entitlements.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the entitlement to retrieve.", +"location": "path", +"pattern": "^providers/[^/]+/entitlements/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Entitlement" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Entitlements for which the provider has read access.", +"flatPath": "v1/providers/{providersId}/entitlements", +"httpMethod": "GET", +"id": "cloudcommerceprocurement.providers.entitlements.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "The filter that can be used to limit the list request. The filter is a query string that can match a selected set of attributes with string values. For example `account=E-1234-5678-ABCD-EFGH`, `state=pending_cancellation`, and `plan!=foo-plan`. Supported query attributes are * `account` * `customer_billing_account` with value in the format of: `billingAccounts/{id}` * `product_external_name` * `quote_external_name` * `offer` * `new_pending_offer` * `plan` * `newPendingPlan` or `new_pending_plan` * `state` * `services` * `consumers.project` * `change_history.new_offer` Note that the consumers and change_history.new_offer match works on repeated structures, so equality (`consumers.project=projects/123456789`) is not supported. Set membership can be expressed with the `:` operator. For example, `consumers.project:projects/123456789` finds entitlements with at least one consumer with project field equal to `projects/123456789`. `change_history.new_offer` retrieves all entitlements that were once associated or are currently active with the offer. Also note that the state name match is case-insensitive and query can omit the prefix \"ENTITLEMENT_\". For example, `state=active` is equivalent to `state=ENTITLEMENT_ACTIVE`. If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, `product=\"providerId:productId\"`, where the product name needs to be quoted because it contains special character colon. Queries can be combined with `AND`, `OR`, and `NOT` to form more complex queries. They can also be grouped to force a desired evaluation order. For example, `state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product)`. Connective `AND` can be omitted between two predicates. For example `account=E-1234 state=active` is equivalent to `account=E-1234 AND state=active`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of entries that are requested. The default page size is 200.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The token for fetching the next page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name.", +"location": "path", +"pattern": "^providers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/entitlements", +"response": { +"$ref": "ListEntitlementsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an existing Entitlement.", +"flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}", +"httpMethod": "PATCH", +"id": "cloudcommerceprocurement.providers.entitlements.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the entitlement to update.", +"location": "path", +"pattern": "^providers/[^/]+/entitlements/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The update mask that applies to the resource. See the [FieldMask definition] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) for more details.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Entitlement" +}, +"response": { +"$ref": "Entitlement" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"reject": { +"description": "Rejects an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is invoked by the provider to reject the creation of the entitlement resource.", +"flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:reject", +"httpMethod": "POST", +"id": "cloudcommerceprocurement.providers.entitlements.reject", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the entitlement.", +"location": "path", +"pattern": "^providers/[^/]+/entitlements/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:reject", +"request": { +"$ref": "RejectEntitlementRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"rejectPlanChange": { +"description": "Rejects an entitlement plan change that is in the EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This method is invoked by the provider to reject the plan change on the entitlement resource.", +"flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange", +"httpMethod": "POST", +"id": "cloudcommerceprocurement.providers.entitlements.rejectPlanChange", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the entitlement.", +"location": "path", +"pattern": "^providers/[^/]+/entitlements/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:rejectPlanChange", +"request": { +"$ref": "RejectEntitlementPlanChangeRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"suspend": { +"description": "Requests suspension of an active Entitlement. This is not yet supported.", +"flatPath": "v1/providers/{providersId}/entitlements/{entitlementsId}:suspend", +"httpMethod": "POST", +"id": "cloudcommerceprocurement.providers.entitlements.suspend", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the entitlement to suspend.", +"location": "path", +"pattern": "^providers/[^/]+/entitlements/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:suspend", +"request": { +"$ref": "SuspendEntitlementRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +}, +"revision": "20250831", +"rootUrl": "https://cloudcommerceprocurement.googleapis.com/", +"schemas": { +"Account": { +"description": "Represents an account that was established by the customer on the service provider's system.", +"id": "Account", +"properties": { +"approvals": { +"description": "Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened.", +"items": { +"$ref": "Approval" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. The creation timestamp.", +"format": "google-datetime", +"type": "string" +}, +"inputProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"deprecated": true, +"description": "Output only. The custom properties that were collected from the user to create this account.", +"type": "object" +}, +"name": { +"description": "Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.", +"type": "string" +}, +"provider": { +"description": "Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.", +"type": "string" +}, +"state": { +"description": "Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.", +"enum": [ +"ACCOUNT_STATE_UNSPECIFIED", +"ACCOUNT_ACTIVATION_REQUESTED", +"ACCOUNT_ACTIVE" +], +"enumDescriptions": [ +"Default state of the account. It's only set to this value when the account is first created and has not been initialized.", +"The customer has requested the creation of the account resource, and the provider notification message is dispatched. This state has been deprecated, as accounts now immediately transition to AccountState.ACCOUNT_ACTIVE.", +"The account is active and ready for use. The next possible states are: - Account getting deleted: After the user invokes delete from another API." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. The last update timestamp.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"Approval": { +"description": "An approval for some action on an account.", +"id": "Approval", +"properties": { +"name": { +"description": "Output only. The name of the approval.", +"type": "string" +}, +"reason": { +"description": "Output only. An explanation for the state of the approval.", +"type": "string" +}, +"state": { +"description": "Output only. The state of the approval.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"APPROVED", +"REJECTED" +], +"enumDescriptions": [ +"Sentinel value; do not use.", +"The approval is pending response from the provider. The approval state can transition to Account.Approval.State.APPROVED or Account.Approval.State.REJECTED.", +"The approval has been granted by the provider.", +"The approval has been rejected by the provider. A provider may choose to approve a previously rejected approval, so is it possible to transition to Account.Approval.State.APPROVED." +], +"type": "string" +}, +"updateTime": { +"description": "Optional. The last update timestamp of the approval.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"ApproveAccountRequest": { +"description": "Request message for PartnerProcurementService.ApproveAccount.", +"id": "ApproveAccountRequest", +"properties": { +"approvalName": { +"description": "The name of the approval being approved. If absent and there is only one approval possible, that approval will be granted. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.", +"type": "string" +}, +"properties": { +"additionalProperties": { +"type": "string" +}, +"description": "Set of properties that should be associated with the account. Optional.", +"type": "object" +}, +"reason": { +"description": "Free form text string explaining the approval reason. Optional. Max allowed length: 256 bytes. Longer strings will be truncated.", +"type": "string" +} +}, +"type": "object" +}, +"ApproveEntitlementPlanChangeRequest": { +"description": "Request message for [PartnerProcurementService.ApproveEntitlementPlanChange[].", +"id": "ApproveEntitlementPlanChangeRequest", +"properties": { +"pendingPlanName": { +"description": "Required. Name of the pending plan that's being approved.", +"type": "string" +} +}, +"type": "object" +}, +"ApproveEntitlementRequest": { +"description": "Request message for [PartnerProcurementService.ApproveEntitlement[].", +"id": "ApproveEntitlementRequest", +"properties": { +"entitlementMigrated": { +"description": "Optional. The resource name of the entitlement that was migrated, with the format `providers/{provider_id}/entitlements/{entitlement_id}`. Should only be sent when resources have been migrated from entitlement_migrated to the new entitlement. Optional.", +"type": "string" +}, +"properties": { +"additionalProperties": { +"type": "string" +}, +"deprecated": true, +"description": "Set of properties that should be associated with the entitlement. Optional.", +"type": "object" +} +}, +"type": "object" +}, +"Consumer": { +"description": "A resource using (consuming) this entitlement.", +"id": "Consumer", +"properties": { +"project": { +"description": "A project name with format `projects/`.", +"type": "string" +} +}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"Entitlement": { +"description": "Represents a procured product of a customer.", +"id": "Entitlement", +"properties": { +"account": { +"description": "Output only. The resource name of the account that this entitlement is based on, if any.", +"type": "string" +}, +"cancellationReason": { +"description": "Output only. The reason the entitlement was cancelled. If this entitlement wasn't cancelled, this field is empty. Possible values include \"unknown\", \"expired\", \"user-cancelled\", \"account-closed\", \"billing-disabled\" (if the customer has manually disabled billing to their resources), \"user-aborted\", and \"migrated\" (if the entitlement has migrated across products). Values of this field are subject to change, and we recommend that you don't build your technical integration to rely on these fields.", +"readOnly": true, +"type": "string" +}, +"consumers": { +"description": "Output only. The resources using this entitlement, if applicable.", +"items": { +"$ref": "Consumer" +}, +"type": "array" +}, +"createTime": { +"description": "Output only. The creation timestamp.", +"format": "google-datetime", +"type": "string" +}, +"entitlementBenefitIds": { +"description": "Output only. The entitlement benefit IDs associated with the purchase.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"inputProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"deprecated": true, +"description": "Output only. The custom properties that were collected from the user to create this entitlement.", +"type": "object" +}, +"messageToUser": { +"description": "Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.", +"type": "string" +}, +"newOfferEndTime": { +"description": "Output only. The end time of the new offer. If the offer was created with a term instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is be empty.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"newOfferStartTime": { +"description": "Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"newPendingOffer": { +"description": "Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part.", +"readOnly": true, +"type": "string" +}, +"newPendingOfferDuration": { +"description": "Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was created with a specified end date instead of a duration, this field is empty.", +"readOnly": true, +"type": "string" +}, +"newPendingPlan": { +"description": "Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.", +"type": "string" +}, +"offer": { +"description": "Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part.", +"readOnly": true, +"type": "string" +}, +"offerDuration": { +"description": "Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer was created with a specified end date instead of a duration, this field is empty.", +"readOnly": true, +"type": "string" +}, +"offerEndTime": { +"description": "Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"orderId": { +"description": "Output only. The order ID of this entitlement, without any `orders/` resource name prefix.", +"readOnly": true, +"type": "string" +}, +"plan": { +"description": "Output only. The identifier of the plan that was procured. Required if the product has plans.", +"type": "string" +}, +"product": { +"deprecated": true, +"description": "Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer.", +"type": "string" +}, +"productExternalName": { +"description": "Output only. The identifier of the product that was procured.", +"readOnly": true, +"type": "string" +}, +"provider": { +"description": "Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.", +"type": "string" +}, +"quoteExternalName": { +"description": "Output only. The identifier of the quote that was used to procure. Empty if the order is not purchased using a quote.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the entitlement.", +"enum": [ +"ENTITLEMENT_STATE_UNSPECIFIED", +"ENTITLEMENT_ACTIVATION_REQUESTED", +"ENTITLEMENT_ACTIVE", +"ENTITLEMENT_PENDING_CANCELLATION", +"ENTITLEMENT_CANCELLED", +"ENTITLEMENT_PENDING_PLAN_CHANGE", +"ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL", +"ENTITLEMENT_SUSPENDED" +], +"enumDescriptions": [ +"Default state of the entitlement. It's only set to this value when the entitlement is first created and has not been initialized.", +"Indicates that the entitlement is being created and the backend has sent a notification to the provider for the activation approval. If the provider approves, then the entitlement will transition to the EntitlementState.ENTITLEMENT_ACTIVE state. Otherwise, the entitlement will be removed. Plan changes are not allowed in this state. Instead the entitlement is cancelled and re-created with a new plan name.", +"Indicates that the entitlement is active. The procured item is now usable and any associated billing events will start occurring. Entitlements in this state WILL renew. The analogous state for an unexpired but non-renewing entitlement is ENTITLEMENT_PENDING_CANCELLATION. In this state, the customer can decide to cancel the entitlement, which would change the state to EntitlementState.ENTITLEMENT_PENDING_CANCELLATION, and then EntitlementState.ENTITLEMENT_CANCELLED. The user can also request a change of plan, which will transition the state to EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE, and then back to EntitlementState.ENTITLEMENT_ACTIVE.", +"Indicates that the entitlement will expire at the end of its term. This could mean the customer has elected not to renew this entitlement or the customer elected to cancel an entitlement that only expires at term end. The entitlement typically stays in this state if the entitlement/plan allows use of the underlying resource until the end of the current billing cycle. Once the billing cycle completes, the resource will transition to EntitlementState.ENTITLEMENT_CANCELLED state. The resource cannot be modified during this state.", +"Indicates that the entitlement was cancelled. The entitlement can now be deleted.", +"Indicates that the entitlement is currently active, but there is a pending plan change that is requested by the customer. The entitlement typically stays in this state, if the entitlement/plan requires the completion of the current billing cycle before the plan can be changed. Once the billing cycle completes, the resource will transition to EntitlementState.ENTITLEMENT_ACTIVE, with its plan changed.", +"Indicates that the entitlement is currently active, but there is a plan change request pending provider approval. If the provider approves the plan change, then the entitlement will transition either to EntitlementState.ENTITLEMENT_ACTIVE or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE depending on whether current plan requires that the billing cycle completes. If the provider rejects the plan change, then the pending plan change request is removed and the entitlement stays in EntitlementState.ENTITLEMENT_ACTIVE state with the old plan.", +"Indicates that the entitlement is suspended either by Google or provider request. This can be triggered for various external reasons (e.g. expiration of credit card on the billing account, violation of terms-of-service of the provider etc.). As such, any remediating action needs to be taken externally, before the entitlement can be activated. This is not yet supported." +], +"type": "string" +}, +"subscriptionEndTime": { +"description": "Output only. End time for the subscription corresponding to this entitlement.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The last update timestamp.", +"format": "google-datetime", +"type": "string" +}, +"usageReportingId": { +"description": "Output only. The consumerId to use when reporting usage through the Service Control API. See the consumerId field at [Reporting Metrics](https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.", +"type": "string" +} +}, +"type": "object" +}, +"ListAccountsResponse": { +"description": "Response message for [PartnerProcurementService.ListAccounts[].", +"id": "ListAccountsResponse", +"properties": { +"accounts": { +"description": "The list of accounts in this response.", +"items": { +"$ref": "Account" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The token for fetching the next page.", +"type": "string" +} +}, +"type": "object" +}, +"ListEntitlementsResponse": { +"description": "Response message for PartnerProcurementService.ListEntitlements.", +"id": "ListEntitlementsResponse", +"properties": { +"entitlements": { +"description": "The list of entitlements in this response.", +"items": { +"$ref": "Entitlement" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The token for fetching the next page.", +"type": "string" +} +}, +"type": "object" +}, +"RejectAccountRequest": { +"description": "Request message for PartnerProcurementService.RejectAccount.", +"id": "RejectAccountRequest", +"properties": { +"approvalName": { +"description": "The name of the approval being rejected. If absent and there is only one approval possible, that approval will be rejected. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.", +"type": "string" +}, +"reason": { +"description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", +"type": "string" +} +}, +"type": "object" +}, +"RejectEntitlementPlanChangeRequest": { +"description": "Request message for PartnerProcurementService.RejectEntitlementPlanChange.", +"id": "RejectEntitlementPlanChangeRequest", +"properties": { +"pendingPlanName": { +"description": "Required. Name of the pending plan that is being rejected.", +"type": "string" +}, +"reason": { +"description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", +"type": "string" +} +}, +"type": "object" +}, +"RejectEntitlementRequest": { +"description": "Request message for PartnerProcurementService.RejectEntitlement.", +"id": "RejectEntitlementRequest", +"properties": { +"reason": { +"description": "Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.", +"type": "string" +} +}, +"type": "object" +}, +"ResetAccountRequest": { +"description": "Request message for PartnerProcurementService.ResetAccount.", +"id": "ResetAccountRequest", +"properties": {}, +"type": "object" +}, +"SuspendEntitlementRequest": { +"description": "Request message for ParterProcurementService.SuspendEntitlement. This is not yet supported.", +"id": "SuspendEntitlementRequest", +"properties": { +"reason": { +"description": "A free-form reason string, explaining the reason for suspension request.", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Cloud Commerce Partner Procurement API", +"version": "v1", +"version_module": true } \ No newline at end of file From 353b32550b03044840da559b8df504a1d866889e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 06/27] feat(connectors): update the api #### connectors:v2 The following keys were added: - schemas.Tool.properties.dependsOn (Total Keys: 2) --- ...tomConnectors.customConnectorVersions.html | 12 +++---- ...cations.providers.connectors.versions.html | 36 +++++++++---------- ....projects.locations.connections.tools.html | 3 ++ .../documents/connectors.v1.json | 4 +-- .../documents/connectors.v2.json | 9 ++++- 5 files changed, 37 insertions(+), 27 deletions(-) diff --git a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html index 8fff3f6e297..dbf40a76ebc 100644 --- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html +++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html @@ -207,7 +207,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -283,7 +283,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -527,7 +527,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -603,7 +603,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -822,7 +822,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -898,7 +898,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html index 5b7e27efc68..8fe95ed13d3 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -208,7 +208,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -284,7 +284,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -418,7 +418,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -492,7 +492,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -568,7 +568,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -644,7 +644,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -748,7 +748,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -827,7 +827,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -935,7 +935,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -1071,7 +1071,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -1147,7 +1147,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -1281,7 +1281,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -1355,7 +1355,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -1431,7 +1431,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -1507,7 +1507,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -1611,7 +1611,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -1690,7 +1690,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. @@ -1798,7 +1798,7 @@

Method Details

"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options "isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings "key": "A String", # Optional. Key of the config variable. - "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "locationType": "A String", # Optional. Location Type denotes where this value should be sent in BYOC connections. "multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable. "allowCustomValues": True or False, # Optional. Allow custom values. "multipleSelectOptions": [ # Required. Multiple select options. diff --git a/docs/dyn/connectors_v2.projects.locations.connections.tools.html b/docs/dyn/connectors_v2.projects.locations.connections.tools.html index ef99af21f85..c0938adf23f 100644 --- a/docs/dyn/connectors_v2.projects.locations.connections.tools.html +++ b/docs/dyn/connectors_v2.projects.locations.connections.tools.html @@ -142,6 +142,9 @@

Method Details

"nextPageToken": "A String", # Next page token. "tools": [ # List of available tools. { # Message representing a single tool. + "dependsOn": [ # List of tool names that this tool depends on. + "A String", + ], "description": "A String", # Description of the tool. "inputSchema": { # JsonSchema representation of schema metadata # JSON schema for the input parameters of the tool. "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 146b2d38fe6..1743147ad73 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2757,7 +2757,7 @@ } } }, -"revision": "20250813", +"revision": "20250826", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -3214,7 +3214,7 @@ "type": "string" }, "locationType": { -"description": "Optional. Location Tyep denotes where this value should be sent in BYOC connections.", +"description": "Optional. Location Type denotes where this value should be sent in BYOC connections.", "enum": [ "LOCATION_TYPE_UNSPECIFIED", "HEADER", diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 34ed55762b9..51c3f92b730 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -769,7 +769,7 @@ } } }, -"revision": "20250813", +"revision": "20250826", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -2710,6 +2710,13 @@ false "description": "Message representing a single tool.", "id": "Tool", "properties": { +"dependsOn": { +"description": "List of tool names that this tool depends on.", +"items": { +"type": "string" +}, +"type": "array" +}, "description": { "description": "Description of the tool.", "type": "string" From e2078e6715a81d469aa15f5fcec722276a3ee895 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 07/27] feat(datamigration): update the api #### datamigration:v1 The following keys were added: - schemas.SqlServerConnectionProfile.properties.cloudSqlProjectId.type (Total Keys: 1) - schemas.SqlServerConnectionProfile.properties.dbmPort (Total Keys: 2) - schemas.SqlServerDagConfig (Total Keys: 4) - schemas.SqlServerHomogeneousMigrationJobConfig.properties.dagConfig.$ref (Total Keys: 1) --- ...projects.locations.connectionProfiles.html | 8 +++++ ...n_v1.projects.locations.migrationJobs.html | 20 +++++++++++++ .../documents/datamigration.v1.json | 30 ++++++++++++++++++- 3 files changed, 57 insertions(+), 1 deletion(-) diff --git a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html index bb2d17c2ea0..23fb84c4f23 100644 --- a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html @@ -327,7 +327,9 @@

Method Details

"gcsPrefix": "A String", # Optional. Cloud Storage path inside the bucket that stores backups. }, "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. + "cloudSqlProjectId": "A String", # Optional. The project id of the Cloud SQL instance. If not provided, the project id of the connection profile will be used. "database": "A String", # Required. The name of the specific database within the host. + "dbmPort": 42, # Optional. The Database Mirroring (DBM) port of the source SQL Server instance. "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. "hostname": "A String", # Required. Hostname for the SSH tunnel. "password": "A String", # Input only. SSH password. @@ -654,7 +656,9 @@

Method Details

"gcsPrefix": "A String", # Optional. Cloud Storage path inside the bucket that stores backups. }, "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. + "cloudSqlProjectId": "A String", # Optional. The project id of the Cloud SQL instance. If not provided, the project id of the connection profile will be used. "database": "A String", # Required. The name of the specific database within the host. + "dbmPort": 42, # Optional. The Database Mirroring (DBM) port of the source SQL Server instance. "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. "hostname": "A String", # Required. Hostname for the SSH tunnel. "password": "A String", # Input only. SSH password. @@ -966,7 +970,9 @@

Method Details

"gcsPrefix": "A String", # Optional. Cloud Storage path inside the bucket that stores backups. }, "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. + "cloudSqlProjectId": "A String", # Optional. The project id of the Cloud SQL instance. If not provided, the project id of the connection profile will be used. "database": "A String", # Required. The name of the specific database within the host. + "dbmPort": 42, # Optional. The Database Mirroring (DBM) port of the source SQL Server instance. "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. "hostname": "A String", # Required. Hostname for the SSH tunnel. "password": "A String", # Input only. SSH password. @@ -1239,7 +1245,9 @@

Method Details

"gcsPrefix": "A String", # Optional. Cloud Storage path inside the bucket that stores backups. }, "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. + "cloudSqlProjectId": "A String", # Optional. The project id of the Cloud SQL instance. If not provided, the project id of the connection profile will be used. "database": "A String", # Required. The name of the specific database within the host. + "dbmPort": 42, # Optional. The Database Mirroring (DBM) port of the source SQL Server instance. "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. "hostname": "A String", # Required. Hostname for the SSH tunnel. "password": "A String", # Input only. SSH password. diff --git a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html index c9f34b8099e..c21e2e0c69a 100644 --- a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html +++ b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html @@ -249,6 +249,10 @@

Method Details

}, "sqlserverHomogeneousMigrationJobConfig": { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration. "backupFilePattern": "A String", # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn + "dagConfig": { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. + "linkedServer": "A String", # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations. + "sourceAg": "A String", # Required. The name of the source availability group. Only used by DAG migrations. + }, "databaseBackups": [ # Required. Backup details per database in Cloud Storage. { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. "database": "A String", # Required. Name of a SQL Server database for which to define backup configuration. @@ -601,6 +605,10 @@

Method Details

}, "sqlserverHomogeneousMigrationJobConfig": { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration. "backupFilePattern": "A String", # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn + "dagConfig": { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. + "linkedServer": "A String", # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations. + "sourceAg": "A String", # Required. The name of the source availability group. Only used by DAG migrations. + }, "databaseBackups": [ # Required. Backup details per database in Cloud Storage. { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. "database": "A String", # Required. Name of a SQL Server database for which to define backup configuration. @@ -800,6 +808,10 @@

Method Details

}, "sqlserverHomogeneousMigrationJobConfig": { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration. "backupFilePattern": "A String", # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn + "dagConfig": { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. + "linkedServer": "A String", # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations. + "sourceAg": "A String", # Required. The name of the source availability group. Only used by DAG migrations. + }, "databaseBackups": [ # Required. Backup details per database in Cloud Storage. { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. "database": "A String", # Required. Name of a SQL Server database for which to define backup configuration. @@ -960,6 +972,10 @@

Method Details

}, "sqlserverHomogeneousMigrationJobConfig": { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration. "backupFilePattern": "A String", # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn + "dagConfig": { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. + "linkedServer": "A String", # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations. + "sourceAg": "A String", # Required. The name of the source availability group. Only used by DAG migrations. + }, "databaseBackups": [ # Required. Backup details per database in Cloud Storage. { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. "database": "A String", # Required. Name of a SQL Server database for which to define backup configuration. @@ -1485,6 +1501,10 @@

Method Details

}, "sqlserverHomogeneousMigrationJobConfig": { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration. "backupFilePattern": "A String", # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn + "dagConfig": { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. + "linkedServer": "A String", # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations. + "sourceAg": "A String", # Required. The name of the source availability group. Only used by DAG migrations. + }, "databaseBackups": [ # Required. Backup details per database in Cloud Storage. { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. "database": "A String", # Required. Name of a SQL Server database for which to define backup configuration. diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index b0181eb499e..e4fdd35bd90 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2345,7 +2345,7 @@ } } }, -"revision": "20250815", +"revision": "20250826", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -6482,10 +6482,19 @@ "description": "If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.", "type": "string" }, +"cloudSqlProjectId": { +"description": "Optional. The project id of the Cloud SQL instance. If not provided, the project id of the connection profile will be used.", +"type": "string" +}, "database": { "description": "Required. The name of the specific database within the host.", "type": "string" }, +"dbmPort": { +"description": "Optional. The Database Mirroring (DBM) port of the source SQL Server instance.", +"format": "int32", +"type": "integer" +}, "forwardSshConnectivity": { "$ref": "ForwardSshTunnelConnectivity", "description": "Forward SSH tunnel connectivity." @@ -6531,6 +6540,21 @@ }, "type": "object" }, +"SqlServerDagConfig": { +"description": "Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration.", +"id": "SqlServerDagConfig", +"properties": { +"linkedServer": { +"description": "Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations.", +"type": "string" +}, +"sourceAg": { +"description": "Required. The name of the source availability group. Only used by DAG migrations.", +"type": "string" +} +}, +"type": "object" +}, "SqlServerDatabaseBackup": { "description": "Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.", "id": "SqlServerDatabaseBackup", @@ -6573,6 +6597,10 @@ "description": "Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\\d{4})(?\\d{2})(?\\d{2})_(?\\d{2})(?\\d{2})(?\\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\\.(?\\d*).trn or (?.*)\\.(?\\d*).trn", "type": "string" }, +"dagConfig": { +"$ref": "SqlServerDagConfig", +"description": "Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration." +}, "databaseBackups": { "description": "Required. Backup details per database in Cloud Storage.", "items": { From cf2823439213374edb16eb612a998c5ce616fea5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 08/27] feat(datastream): update the api #### datastream:v1 The following keys were added: - schemas.MongodbChangeStreamPosition (Total Keys: 4) - schemas.SpecificStartPosition.properties.mongodbChangeStreamPosition.$ref (Total Keys: 1) --- ...tastream_v1.projects.locations.streams.html | 3 +++ .../documents/datastream.v1.json | 18 +++++++++++++++++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/dyn/datastream_v1.projects.locations.streams.html b/docs/dyn/datastream_v1.projects.locations.streams.html index ff79ce3ddac..d0e1e209601 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.html @@ -2317,6 +2317,9 @@

Method Details

"nextAvailableStartPosition": { # CDC strategy to resume replication from the next available position in the source. # Optional. Resume replication from the next available position in the source. }, "specificStartPosition": { # CDC strategy to start replicating from a specific position in the source. # Optional. Start replicating from a specific position in the source. + "mongodbChangeStreamPosition": { # MongoDB change stream position # MongoDB change stream position to start replicating from. + "startTime": "A String", # Required. The timestamp (in epoch seconds) to start change stream from. + }, "mysqlGtidPosition": { # MySQL GTID position # MySQL GTID set to start replicating from. "gtidSet": "A String", # Required. The gtid set to start replication from. }, diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index fcf5efd07a2..a93aa680ad4 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1261,7 +1261,7 @@ } } }, -"revision": "20250817", +"revision": "20250827", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -2155,6 +2155,18 @@ "properties": {}, "type": "object" }, +"MongodbChangeStreamPosition": { +"description": "MongoDB change stream position", +"id": "MongodbChangeStreamPosition", +"properties": { +"startTime": { +"description": "Required. The timestamp (in epoch seconds) to start change stream from.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "MongodbCluster": { "description": "MongoDB Cluster structure.", "id": "MongodbCluster", @@ -3547,6 +3559,10 @@ "description": "CDC strategy to start replicating from a specific position in the source.", "id": "SpecificStartPosition", "properties": { +"mongodbChangeStreamPosition": { +"$ref": "MongodbChangeStreamPosition", +"description": "MongoDB change stream position to start replicating from." +}, "mysqlGtidPosition": { "$ref": "MysqlGtidPosition", "description": "MySQL GTID set to start replicating from." From 500564eb8ee139f3944c9be63fdc80a474aeaeae Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 09/27] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.federatedConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.removeParamKeys (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig (Total Keys: 6) #### discoveryengine:v1alpha The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.federatedConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.removeParamKeys (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings.properties.disableLocationContext (Total Keys: 2) - schemas.GoogleCloudNotebooklmV1alphaFailureReason (Total Keys: 55) - schemas.GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata (Total Keys: 4) - schemas.GoogleCloudNotebooklmV1alphaNotebook.properties.metadata.readOnly (Total Keys: 1) - schemas.GoogleCloudNotebooklmV1alphaNotebook.properties.notebookId.readOnly (Total Keys: 1) - schemas.GoogleCloudNotebooklmV1alphaSource.properties.metadata.readOnly (Total Keys: 1) - schemas.GoogleCloudNotebooklmV1alphaSource.properties.settings (Total Keys: 2) - schemas.GoogleCloudNotebooklmV1alphaSource.properties.sourceId.readOnly (Total Keys: 1) - schemas.GoogleCloudNotebooklmV1alphaSourceMetadata.properties.googleDocsMetadata.$ref (Total Keys: 1) - schemas.GoogleCloudNotebooklmV1alphaSourceMetadata.properties.youtubeMetadata.$ref (Total Keys: 1) - schemas.GoogleCloudNotebooklmV1alphaSourceSettings (Total Keys: 4) - schemas.GoogleCloudNotebooklmV1alphaYoutubeMetadata (Total Keys: 6) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.federatedConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.removeParamKeys (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig (Total Keys: 6) --- ....collections.dataStores.widgetConfigs.html | 1 + ...ons.collections.engines.widgetConfigs.html | 1 + ...1alpha.projects.locations.collections.html | 66 ++++ ...ts.locations.dataStores.widgetConfigs.html | 1 + ...veryengine_v1alpha.projects.locations.html | 11 + ...ts.locations.notebooks.audioOverviews.html | 10 +- ..._v1alpha.projects.locations.notebooks.html | 36 +- ....projects.locations.notebooks.sources.html | 114 +++++- .../documents/discoveryengine.v1.json | 42 +- .../documents/discoveryengine.v1alpha.json | 371 +++++++++++++++++- .../documents/discoveryengine.v1beta.json | 42 +- 11 files changed, 636 insertions(+), 59 deletions(-) diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html index c9889b36aae..0e968c41eea 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -118,6 +118,7 @@

Method Details

], "assistantSettings": { # Describes the assistant settings of the widget. # Optional. Output only. Describes the assistant settings of the widget. "defaultWebGroundingToggleOff": True or False, # Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. + "disableLocationContext": True or False, # Optional. Output only. Whether to disable user location context. "googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html index 66ce6149fa9..0a06a6fcca7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -118,6 +118,7 @@

Method Details

], "assistantSettings": { # Describes the assistant settings of the widget. # Optional. Output only. Describes the assistant settings of the widget. "defaultWebGroundingToggleOff": True or False, # Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. + "disableLocationContext": True or False, # Optional. Output only. Whether to disable user location context. "googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index 1eea4803077..2e0ab101208 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -294,6 +294,14 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + "additionalParams": { # Optional. Any additional parameters needed for FEDERATED. + "a_key": "", # Properties of the object. + }, + "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "a_key": "", # Properties of the object. + }, + }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. @@ -355,6 +363,9 @@

Method Details

"webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync. }, "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + "A String", + ], "state": "A String", # Output only. State of the connector. "staticIpAddresses": [ # Output only. The static IP addresses used by this connector. "A String", @@ -501,6 +512,14 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + "additionalParams": { # Optional. Any additional parameters needed for FEDERATED. + "a_key": "", # Properties of the object. + }, + "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "a_key": "", # Properties of the object. + }, + }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. @@ -562,6 +581,9 @@

Method Details

"webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync. }, "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + "A String", + ], "state": "A String", # Output only. State of the connector. "staticIpAddresses": [ # Output only. The static IP addresses used by this connector. "A String", @@ -712,6 +734,14 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + "additionalParams": { # Optional. Any additional parameters needed for FEDERATED. + "a_key": "", # Properties of the object. + }, + "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "a_key": "", # Properties of the object. + }, + }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. @@ -773,6 +803,9 @@

Method Details

"webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync. }, "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + "A String", + ], "state": "A String", # Output only. State of the connector. "staticIpAddresses": [ # Output only. The static IP addresses used by this connector. "A String", @@ -933,6 +966,14 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + "additionalParams": { # Optional. Any additional parameters needed for FEDERATED. + "a_key": "", # Properties of the object. + }, + "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "a_key": "", # Properties of the object. + }, + }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. @@ -994,6 +1035,9 @@

Method Details

"webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync. }, "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + "A String", + ], "state": "A String", # Output only. State of the connector. "staticIpAddresses": [ # Output only. The static IP addresses used by this connector. "A String", @@ -1164,6 +1208,14 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + "additionalParams": { # Optional. Any additional parameters needed for FEDERATED. + "a_key": "", # Properties of the object. + }, + "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "a_key": "", # Properties of the object. + }, + }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. @@ -1225,6 +1277,9 @@

Method Details

"webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync. }, "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + "A String", + ], "state": "A String", # Output only. State of the connector. "staticIpAddresses": [ # Output only. The static IP addresses used by this connector. "A String", @@ -1362,6 +1417,14 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + "additionalParams": { # Optional. Any additional parameters needed for FEDERATED. + "a_key": "", # Properties of the object. + }, + "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "a_key": "", # Properties of the object. + }, + }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. @@ -1423,6 +1486,9 @@

Method Details

"webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync. }, "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + "A String", + ], "state": "A String", # Output only. State of the connector. "staticIpAddresses": [ # Output only. The static IP addresses used by this connector. "A String", diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index 2b657818e40..d39e167536e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -118,6 +118,7 @@

Method Details

], "assistantSettings": { # Describes the assistant settings of the widget. # Optional. Output only. Describes the assistant settings of the widget. "defaultWebGroundingToggleOff": True or False, # Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. + "disableLocationContext": True or False, # Optional. Output only. Whether to disable user location context. "googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 40d406a9e8d..c032825d8c0 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -1054,6 +1054,14 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. + "additionalParams": { # Optional. Any additional parameters needed for FEDERATED. + "a_key": "", # Properties of the object. + }, + "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "a_key": "", # Properties of the object. + }, + }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. @@ -1115,6 +1123,9 @@

Method Details

"webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync. }, "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. + "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. + "A String", + ], "state": "A String", # Output only. State of the connector. "staticIpAddresses": [ # Output only. The static IP addresses used by this connector. "A String", diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html index 525961e4547..b473a699d39 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

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

-

Generates a new audio overview. Needs a side channel with the user's EUC.

+

Generates a new audio overview.

delete(name, x__xgafv=None)

-

Deletes an audio overview. Needs a side channel with the user's EUC.

+

Deletes an audio overview.

Method Details

close() @@ -91,7 +91,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Generates a new audio overview. Needs a side channel with the user's EUC.
+  
Generates a new audio overview.
 
 Args:
   parent: string, Required. The parent resource where this notebook will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook} (required)
@@ -122,7 +122,7 @@ 

Method Details

"audioOverview": { # An audio overview of a notebook. This is a summary of the notebook in audio format. # The generated audio overview. "audio": "A String", # The audio overview in wav format. This is only present if the status is AUDIO_OVERVIEW_STATUS_COMPLETE. "audioOverviewId": "A String", # Output only. Unique ID of the audio overview. - "languageCode": "A String", # The language code of the generated audio overview. Use the BCP 47 language code (e.g. "en", "es", "hi", etc.). Examples: google3/i18n/identifiers/tools/language_code_constants.txt + "languageCode": "A String", # The language code of the generated audio overview. Use the BCP 47 language code (e.g. "en", "es", "hi", etc.). "mimeType": "A String", # The mime type of the audio overview. "name": "A String", # Identifier. The full resource name of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "playbackUrl": "A String", # The url used to play the audio overview. @@ -133,7 +133,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an audio overview. Needs a side channel with the user's EUC.
+  
Deletes an audio overview.
 
 Args:
   name: string, Required. The full resource name of the AudioOverview, such as `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`. (required)
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.html
index e62d449c64e..9a6b0bf0c0a 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.html
@@ -86,29 +86,29 @@ 

Instance Methods

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

-

Batch deletes Notebooks. Needs a side channel with the user's EUC.

+

Batch deletes Notebooks.

close()

Close httplib2 connections.

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

-

Creates a notebook. Needs a side channel with the user's EUC.

+

Creates a notebook.

get(name, x__xgafv=None)

-

Gets a notebook. Needs a side channel with the user's EUC.

+

Gets a notebook.

listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists the recently viewed notebooks. Needs a side channel with the user's EUC.

+

Lists the notebooks ordered by last view time.

listRecentlyViewed_next()

Retrieves the next page of results.

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

-

Shares a notebook to other accounts. Needs a side channel with the user's EUC.

+

Shares a notebook to other accounts.

Method Details

batchDelete(parent, body=None, x__xgafv=None) -
Batch deletes Notebooks. Needs a side channel with the user's EUC.
+  
Batch deletes Notebooks.
 
 Args:
   parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
@@ -140,7 +140,7 @@ 

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a notebook. Needs a side channel with the user's EUC.
+  
Creates a notebook.
 
 Args:
   parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
@@ -152,14 +152,14 @@ 

Method Details

"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. }, "emoji": "A String", # Output only. The emoji of the notebook. - "metadata": { # Metadata for a notebook. # The metadata of the notebook. + "metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook. "createTime": "A String", # The time at which this project was created. "isShareable": True or False, # True if the project is shareable. "isShared": True or False, # True if this project is currently shared with other people, false otherwise. "lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project. }, "name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string. - "notebookId": "A String", # Optional. Notebook id, which is the last segment of the notebook's resource name. This is to make it similar with notebooklm API. + "notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name. "title": "A String", # Optional. The title of the notebook. } @@ -176,21 +176,21 @@

Method Details

"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. }, "emoji": "A String", # Output only. The emoji of the notebook. - "metadata": { # Metadata for a notebook. # The metadata of the notebook. + "metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook. "createTime": "A String", # The time at which this project was created. "isShareable": True or False, # True if the project is shareable. "isShared": True or False, # True if this project is currently shared with other people, false otherwise. "lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project. }, "name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string. - "notebookId": "A String", # Optional. Notebook id, which is the last segment of the notebook's resource name. This is to make it similar with notebooklm API. + "notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name. "title": "A String", # Optional. The title of the notebook. }
get(name, x__xgafv=None) -
Gets a notebook. Needs a side channel with the user's EUC.
+  
Gets a notebook.
 
 Args:
   name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
@@ -207,21 +207,21 @@ 

Method Details

"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. }, "emoji": "A String", # Output only. The emoji of the notebook. - "metadata": { # Metadata for a notebook. # The metadata of the notebook. + "metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook. "createTime": "A String", # The time at which this project was created. "isShareable": True or False, # True if the project is shareable. "isShared": True or False, # True if this project is currently shared with other people, false otherwise. "lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project. }, "name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string. - "notebookId": "A String", # Optional. Notebook id, which is the last segment of the notebook's resource name. This is to make it similar with notebooklm API. + "notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name. "title": "A String", # Optional. The title of the notebook. }
listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the recently viewed notebooks. Needs a side channel with the user's EUC.
+  
Lists the notebooks ordered by last view time.
 
 Args:
   parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
@@ -243,14 +243,14 @@ 

Method Details

"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. }, "emoji": "A String", # Output only. The emoji of the notebook. - "metadata": { # Metadata for a notebook. # The metadata of the notebook. + "metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook. "createTime": "A String", # The time at which this project was created. "isShareable": True or False, # True if the project is shareable. "isShared": True or False, # True if this project is currently shared with other people, false otherwise. "lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project. }, "name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string. - "notebookId": "A String", # Optional. Notebook id, which is the last segment of the notebook's resource name. This is to make it similar with notebooklm API. + "notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name. "title": "A String", # Optional. The title of the notebook. }, ], @@ -273,7 +273,7 @@

Method Details

share(name, body=None, x__xgafv=None) -
Shares a notebook to other accounts. Needs a side channel with the user's EUC.
+  
Shares a notebook to other accounts.
 
 Args:
   name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html
index 3ae3a76315c..bb4a2d5de63 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html
@@ -109,18 +109,18 @@ 

Method Details

}, "googleDriveContent": { # The content from Google Drive. # The content from Google Drive. "documentId": "A String", # The document id of the selected document. - "mimeType": "A String", # The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker. - "sourceName": "A String", # Should track this from Drive Picker. + "mimeType": "A String", # The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker. Use application/vnd.google-apps.document for Google Docs or application/vnd.google-apps.presentation for Google Slides. + "sourceName": "A String", # Name to be displayed for the source. }, "textContent": { # The text content uploaded as source. # The text content uploaded as source. - "content": "A String", # The content of the text source. - "sourceName": "A String", # The name of the text source. + "content": "A String", # Name to be displayed for the source. + "sourceName": "A String", # The display name of the text source. }, "videoContent": { # Video content uploaded as source. # The video content uploaded as source. "youtubeUrl": "A String", # The youtube url of the video content. }, "webContent": { # The web content uploaded as source. # The web content uploaded as source. - "sourceName": "A String", # The name of the web source. + "sourceName": "A String", # Name to be displayed for the source. "url": "A String", # If URL is supplied, will fetch the webpage in the backend. }, }, @@ -138,17 +138,65 @@

Method Details

{ # Response for SourceService.BatchCreateSources method. "sources": [ # The Sources. { # Source represents a single source of content. - "metadata": { # Represents the metadata of a source and some additional information. # Metadata about the source. + "metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source. "agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source. "documentName": "A String", # Output only. The full document name in Agentspace. "documentTitle": "A String", # Output only. The title of the document. }, + "googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source. + "documentId": "A String", # Output only. The document id of the google doc. + "revisionId": "A String", # Output only. Revision id for the doc. + }, "sourceAddedTimestamp": "A String", # The timestamp the source was added. "tokenCount": 42, # The number of tokens in the source. "wordCount": 42, # The word count of the source. + "youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source. + "channelName": "A String", # Output only. The channel name of the youtube video. + "videoId": "A String", # Output only. The id of the youtube video. + }, }, "name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Source id, which is the last segment of the source's resource name. This is to make it similar with notebooklm API. + "settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons. + "failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest. + "audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error. + "languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech). + }, + "noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video). + }, + }, + "domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain. + }, + "googleDriveError": { # A google drive specific error. # A google drive specific error. + "downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file. + }, + }, + "ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source. + }, + "paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested. + }, + "sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty. + }, + "sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits. + }, + "sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit. + "wordCount": 42, # The number of words in the source. + "wordLimit": 42, # The word count limit for the current user at the time of the upload. + }, + "sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable. + "errorDetails": "A String", # Describes why the source is unreachable. + }, + "unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred. + }, + "uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source. + }, + "youtubeError": { # A youtube specific error. # A youtube specific error. + "videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted. + }, + }, + }, + "status": "A String", # Status of the source. + }, + "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name. "id": "A String", # The id of the source. }, "title": "A String", # Optional. Title of the source. @@ -204,17 +252,65 @@

Method Details

An object of the form: { # Source represents a single source of content. - "metadata": { # Represents the metadata of a source and some additional information. # Metadata about the source. + "metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source. "agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source. "documentName": "A String", # Output only. The full document name in Agentspace. "documentTitle": "A String", # Output only. The title of the document. }, + "googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source. + "documentId": "A String", # Output only. The document id of the google doc. + "revisionId": "A String", # Output only. Revision id for the doc. + }, "sourceAddedTimestamp": "A String", # The timestamp the source was added. "tokenCount": 42, # The number of tokens in the source. "wordCount": 42, # The word count of the source. + "youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source. + "channelName": "A String", # Output only. The channel name of the youtube video. + "videoId": "A String", # Output only. The id of the youtube video. + }, }, "name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Source id, which is the last segment of the source's resource name. This is to make it similar with notebooklm API. + "settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons. + "failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest. + "audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error. + "languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech). + }, + "noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video). + }, + }, + "domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain. + }, + "googleDriveError": { # A google drive specific error. # A google drive specific error. + "downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file. + }, + }, + "ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source. + }, + "paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested. + }, + "sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty. + }, + "sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits. + }, + "sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit. + "wordCount": 42, # The number of words in the source. + "wordLimit": 42, # The word count limit for the current user at the time of the upload. + }, + "sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable. + "errorDetails": "A String", # Describes why the source is unreachable. + }, + "unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred. + }, + "uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source. + }, + "youtubeError": { # A youtube specific error. # A youtube specific error. + "videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted. + }, + }, + }, + "status": "A String", # Status of the source. + }, + "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name. "id": "A String", # The id of the source. }, "title": "A String", # Optional. Title of the source. diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index ce67a0db1c9..2abfb0b3bd0 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -7344,7 +7344,7 @@ } } }, -"revision": "20250824", +"revision": "20250902", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -18262,12 +18262,14 @@ false "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", -"ALLOWLIST_IN_SERVICE_ATTACHMENT" +"ALLOWLIST_IN_SERVICE_ATTACHMENT", +"ALLOWLIST_SERVICE_ACCOUNT" ], "enumDescriptions": [ "Default value.", "Connector requires customer to allowlist static IPs.", -"Connector requires customer to allowlist our project in their service attachment." +"Connector requires customer to allowlist our project in their service attachment.", +"Connector requires customer to allowlist service account in their project." ], "type": "string" }, @@ -18370,6 +18372,10 @@ false "readOnly": true, "type": "array" }, +"federatedConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", +"description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." +}, "hybridIngestionDisabled": { "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.", "type": "boolean" @@ -18465,6 +18471,13 @@ false "format": "google-duration", "type": "string" }, +"removeParamKeys": { +"description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", +"items": { +"type": "string" +}, +"type": "array" +}, "state": { "description": "Output only. State of the connector.", "enum": [ @@ -18552,6 +18565,29 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig": { +"description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", +"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", +"properties": { +"additionalParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Any additional parameters needed for FEDERATED.", +"type": "object" +}, +"authParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Any authentication parameters specific to FEDERATED.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { "description": "The configuration for realtime sync to store additional params for realtime sync.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 68f6a21876f..52200f873ab 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -8481,7 +8481,7 @@ "notebooks": { "methods": { "batchDelete": { -"description": "Batch deletes Notebooks. Needs a side channel with the user's EUC.", +"description": "Batch deletes Notebooks.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks:batchDelete", "httpMethod": "POST", "id": "discoveryengine.projects.locations.notebooks.batchDelete", @@ -8509,7 +8509,7 @@ ] }, "create": { -"description": "Creates a notebook. Needs a side channel with the user's EUC.", +"description": "Creates a notebook.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks", "httpMethod": "POST", "id": "discoveryengine.projects.locations.notebooks.create", @@ -8537,7 +8537,7 @@ ] }, "get": { -"description": "Gets a notebook. Needs a side channel with the user's EUC.", +"description": "Gets a notebook.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}", "httpMethod": "GET", "id": "discoveryengine.projects.locations.notebooks.get", @@ -8562,7 +8562,7 @@ ] }, "listRecentlyViewed": { -"description": "Lists the recently viewed notebooks. Needs a side channel with the user's EUC.", +"description": "Lists the notebooks ordered by last view time.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks:listRecentlyViewed", "httpMethod": "GET", "id": "discoveryengine.projects.locations.notebooks.listRecentlyViewed", @@ -8598,7 +8598,7 @@ ] }, "share": { -"description": "Shares a notebook to other accounts. Needs a side channel with the user's EUC.", +"description": "Shares a notebook to other accounts.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}:share", "httpMethod": "POST", "id": "discoveryengine.projects.locations.notebooks.share", @@ -8630,7 +8630,7 @@ "audioOverviews": { "methods": { "create": { -"description": "Generates a new audio overview. Needs a side channel with the user's EUC.", +"description": "Generates a new audio overview.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/audioOverviews", "httpMethod": "POST", "id": "discoveryengine.projects.locations.notebooks.audioOverviews.create", @@ -8658,7 +8658,7 @@ ] }, "delete": { -"description": "Deletes an audio overview. Needs a side channel with the user's EUC.", +"description": "Deletes an audio overview.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/audioOverviews/{audioOverviewsId}", "httpMethod": "DELETE", "id": "discoveryengine.projects.locations.notebooks.audioOverviews.delete", @@ -9676,7 +9676,7 @@ } } }, -"revision": "20250824", +"revision": "20250902", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -17695,12 +17695,14 @@ "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", -"ALLOWLIST_IN_SERVICE_ATTACHMENT" +"ALLOWLIST_IN_SERVICE_ATTACHMENT", +"ALLOWLIST_SERVICE_ACCOUNT" ], "enumDescriptions": [ "Default value.", "Connector requires customer to allowlist static IPs.", -"Connector requires customer to allowlist our project in their service attachment." +"Connector requires customer to allowlist our project in their service attachment.", +"Connector requires customer to allowlist service account in their project." ], "type": "string" }, @@ -17803,6 +17805,10 @@ "readOnly": true, "type": "array" }, +"federatedConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", +"description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." +}, "hybridIngestionDisabled": { "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.", "type": "boolean" @@ -17898,6 +17904,13 @@ "format": "google-duration", "type": "string" }, +"removeParamKeys": { +"description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", +"items": { +"type": "string" +}, +"type": "array" +}, "state": { "description": "Output only. State of the connector.", "enum": [ @@ -17985,6 +17998,29 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig": { +"description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", +"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", +"properties": { +"additionalParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Any additional parameters needed for FEDERATED.", +"type": "object" +}, +"authParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Any authentication parameters specific to FEDERATED.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { "description": "The configuration for realtime sync to store additional params for realtime sync.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", @@ -26074,6 +26110,11 @@ false "readOnly": true, "type": "boolean" }, +"disableLocationContext": { +"description": "Optional. Output only. Whether to disable user location context.", +"readOnly": true, +"type": "boolean" +}, "googleSearchGroundingEnabled": { "deprecated": true, "description": "Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.", @@ -30096,7 +30137,7 @@ false "PROJECT_ROLE_NOT_SHARED" ], "enumDescriptions": [ -"Unknown role - do not use.", +"Unknown role.", "The user owns the project.", "The user has writer permissions on the project.", "The user has reader permissions on the project.", @@ -30139,7 +30180,7 @@ false "type": "string" }, "languageCode": { -"description": "The language code of the generated audio overview. Use the BCP 47 language code (e.g. \"en\", \"es\", \"hi\", etc.). Examples: google3/i18n/identifiers/tools/language_code_constants.txt", +"description": "The language code of the generated audio overview. Use the BCP 47 language code (e.g. \"en\", \"es\", \"hi\", etc.).", "type": "string" }, "mimeType": { @@ -30296,6 +30337,229 @@ false }, "type": "object" }, +"GoogleCloudNotebooklmV1alphaFailureReason": { +"description": "Failure reason containing details about why a source failed to ingest.", +"id": "GoogleCloudNotebooklmV1alphaFailureReason", +"properties": { +"audioTranscriptionError": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError", +"description": "An audio file transcription specific error." +}, +"domainBlocked": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked", +"description": "Error if the user tries to add a source from a blocked domain." +}, +"googleDriveError": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError", +"description": "A google drive specific error." +}, +"ingestionError": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError", +"description": "Indicates an error occurred while ingesting the source." +}, +"paywallError": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError", +"description": "Indicates that the source is paywalled and cannot be ingested." +}, +"sourceEmpty": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty", +"description": "Indicates that the source is empty." +}, +"sourceLimitExceeded": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded", +"description": "Error if the user tries to update beyond their limits." +}, +"sourceTooLong": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong", +"description": "Indicates source word count exceeded the user's limit." +}, +"sourceUnreachable": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable", +"description": "Indicates that the source is unreachable." +}, +"unknown": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonUnknown", +"description": "Indicates an unknown error occurred." +}, +"uploadError": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonUploadError", +"description": "Indicates an error occurred while uploading the source." +}, +"youtubeError": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError", +"description": "A youtube specific error." +} +}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError": { +"description": "An audio file transcription specific error.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError", +"properties": { +"languageDetectionFailed": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed", +"description": "Could not detect language of the file (it may not be speech)." +}, +"noAudioDetected": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected", +"description": "No audio was detected in the input file (it may have been a video)." +} +}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed": { +"description": "Could not detect language of the file (it may not be speech).", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected": { +"description": "No audio was detected in the input file.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked": { +"description": "Error to indicate that the source was removed because the domain was blocked.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError": { +"description": "A google drive specific error.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError", +"properties": { +"downloadPrevented": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented", +"description": "The user was prevented from downloading the file." +} +}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented": { +"description": "The user was prevented from downloading the file.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonIngestionError": { +"description": "Indicates an error occurred while ingesting the source.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonPaywallError": { +"description": "Indicates that the source is paywalled and cannot be ingested.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty": { +"description": "Indicates that the source is empty.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded": { +"description": "Indicates that the user does not have space for this source.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong": { +"description": "Indicates source word count exceeded the user's limit.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong", +"properties": { +"wordCount": { +"description": "The number of words in the source.", +"format": "int32", +"type": "integer" +}, +"wordLimit": { +"description": "The word count limit for the current user at the time of the upload.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable": { +"description": "Indicates that the source is unreachable. This is primarily used for sources that are added via URL.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable", +"properties": { +"errorDetails": { +"description": "Describes why the source is unreachable.", +"enum": [ +"ERROR_REASON_UNSPECIFIED", +"ERROR_REASON_INVALID_URL", +"ERROR_REASON_NOT_ACCESSIBLE", +"ERROR_REASON_NOT_REACHABLE", +"ERROR_REASON_URL_NOT_FOUND", +"ERROR_REASON_TRANSIENT_ERROR", +"ERROR_REASON_FETCH_FAILED", +"ERROR_REASON_NOT_SUPPORTED" +], +"enumDescriptions": [ +"Default", +"The source URL is invalid.", +"The source URL is not accessible.", +"The source URL is not reachable.", +"The source URL returned 404.", +"The source URL not reachable due to a transient network error or host timeout etc.", +"The source URL could not be fetched due to an internal error.", +"The URL is not yet supported. Examples include: the fetched content exceeds the trawler fetch max size, the fetched content is a type we do not yet support, etc." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonUnknown": { +"description": "Indicates an unknown error occurred.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonUnknown", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonUploadError": { +"description": "Indicates an error occurred while uploading the source.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonUploadError", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError": { +"description": "A youtube specific error.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError", +"properties": { +"videoDeleted": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted", +"description": "Error to indicate that the source was removed because the video was deleted." +} +}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted": { +"description": "Error to indicate that the source was removed because the video was deleted.", +"id": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted", +"properties": {}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata": { +"description": "Metadata about a google doc source.", +"id": "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata", +"properties": { +"documentId": { +"description": "Output only. The document id of the google doc.", +"readOnly": true, +"type": "string" +}, +"revisionId": { +"description": "Output only. Revision id for the doc.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse": { "description": "Response for NotebookService.ListRecentlyViewedNotebooks method.", "id": "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse", @@ -30330,14 +30594,16 @@ false }, "metadata": { "$ref": "GoogleCloudNotebooklmV1alphaNotebookMetadata", -"description": "The metadata of the notebook." +"description": "Output only. The metadata of the notebook.", +"readOnly": true }, "name": { "description": "Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.", "type": "string" }, "notebookId": { -"description": "Optional. Notebook id, which is the last segment of the notebook's resource name. This is to make it similar with notebooklm API.", +"description": "Output only. Notebook id, which is the last segment of the notebook's resource name.", +"readOnly": true, "type": "string" }, "title": { @@ -30402,15 +30668,22 @@ false "properties": { "metadata": { "$ref": "GoogleCloudNotebooklmV1alphaSourceMetadata", -"description": "Metadata about the source." +"description": "Output only. Metadata about the source.", +"readOnly": true }, "name": { "description": "Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, +"settings": { +"$ref": "GoogleCloudNotebooklmV1alphaSourceSettings", +"description": "Output only. Status of the source, and any failure reasons.", +"readOnly": true +}, "sourceId": { "$ref": "GoogleCloudNotebooklmV1alphaSourceId", -"description": "Optional. Source id, which is the last segment of the source's resource name. This is to make it similar with notebooklm API." +"description": "Optional. Output only. Source id, which is the last segment of the source's resource name.", +"readOnly": true }, "title": { "description": "Optional. Title of the source.", @@ -30438,6 +30711,10 @@ false "$ref": "GoogleCloudNotebooklmV1alphaAgentspaceMetadata", "description": "Metadata for an agentspace source." }, +"googleDocsMetadata": { +"$ref": "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata", +"description": "Metadata for a google doc source." +}, "sourceAddedTimestamp": { "description": "The timestamp the source was added.", "format": "google-datetime", @@ -30452,6 +30729,41 @@ false "description": "The word count of the source.", "format": "int32", "type": "integer" +}, +"youtubeMetadata": { +"$ref": "GoogleCloudNotebooklmV1alphaYoutubeMetadata", +"description": "Metadata for a youtube video source." +} +}, +"type": "object" +}, +"GoogleCloudNotebooklmV1alphaSourceSettings": { +"description": "Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request).", +"id": "GoogleCloudNotebooklmV1alphaSourceSettings", +"properties": { +"failureReason": { +"$ref": "GoogleCloudNotebooklmV1alphaFailureReason", +"description": "Failure reason containing details about why a source failed to ingest." +}, +"status": { +"description": "Status of the source.", +"enum": [ +"SOURCE_STATUS_UNSPECIFIED", +"SOURCE_STATUS_PENDING", +"SOURCE_STATUS_COMPLETE", +"SOURCE_STATUS_ERROR", +"SOURCE_STATUS_PENDING_DELETION", +"SOURCE_STATUS_TENTATIVE" +], +"enumDescriptions": [ +"Unspecified status.", +"The source is pending addition.", +"Source addition is complete and successful.", +"Source addition has permanently failed.", +"The source is pending deletion.", +"The user is attempting to add a source, but we have not yet uploaded it or checked user limits. Does not count towards the user's source limit." +], +"type": "string" } }, "type": "object" @@ -30545,11 +30857,11 @@ false "type": "string" }, "mimeType": { -"description": "The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker.", +"description": "The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker. Use application/vnd.google-apps.document for Google Docs or application/vnd.google-apps.presentation for Google Slides.", "type": "string" }, "sourceName": { -"description": "Should track this from Drive Picker.", +"description": "Name to be displayed for the source.", "type": "string" } }, @@ -30560,11 +30872,11 @@ false "id": "GoogleCloudNotebooklmV1alphaUserContentTextContent", "properties": { "content": { -"description": "The content of the text source.", +"description": "Name to be displayed for the source.", "type": "string" }, "sourceName": { -"description": "The name of the text source.", +"description": "The display name of the text source.", "type": "string" } }, @@ -30586,7 +30898,7 @@ false "id": "GoogleCloudNotebooklmV1alphaUserContentWebContent", "properties": { "sourceName": { -"description": "The name of the web source.", +"description": "Name to be displayed for the source.", "type": "string" }, "url": { @@ -30596,6 +30908,23 @@ false }, "type": "object" }, +"GoogleCloudNotebooklmV1alphaYoutubeMetadata": { +"description": "Metadata about a youtube video source.", +"id": "GoogleCloudNotebooklmV1alphaYoutubeMetadata", +"properties": { +"channelName": { +"description": "Output only. The channel name of the youtube video.", +"readOnly": true, +"type": "string" +}, +"videoId": { +"description": "Output only. The id of the youtube video.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 338f3e7b3ba..d6d5c3f0554 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -8200,7 +8200,7 @@ } } }, -"revision": "20250824", +"revision": "20250902", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -13491,12 +13491,14 @@ "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", -"ALLOWLIST_IN_SERVICE_ATTACHMENT" +"ALLOWLIST_IN_SERVICE_ATTACHMENT", +"ALLOWLIST_SERVICE_ACCOUNT" ], "enumDescriptions": [ "Default value.", "Connector requires customer to allowlist static IPs.", -"Connector requires customer to allowlist our project in their service attachment." +"Connector requires customer to allowlist our project in their service attachment.", +"Connector requires customer to allowlist service account in their project." ], "type": "string" }, @@ -13599,6 +13601,10 @@ "readOnly": true, "type": "array" }, +"federatedConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", +"description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." +}, "hybridIngestionDisabled": { "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.", "type": "boolean" @@ -13694,6 +13700,13 @@ "format": "google-duration", "type": "string" }, +"removeParamKeys": { +"description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", +"items": { +"type": "string" +}, +"type": "array" +}, "state": { "description": "Output only. State of the connector.", "enum": [ @@ -13781,6 +13794,29 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig": { +"description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", +"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", +"properties": { +"additionalParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Any additional parameters needed for FEDERATED.", +"type": "object" +}, +"authParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Any authentication parameters specific to FEDERATED.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { "description": "The configuration for realtime sync to store additional params for realtime sync.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", From 81e45356e2c95f69f15fc33d490d3d59775cd137 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 10/27] feat(drive): update the api #### drive:v3 The following keys were added: - resources.files.methods.copy.parameters.enforceSingleParent.deprecated (Total Keys: 1) - resources.files.methods.create.parameters.enforceSingleParent.deprecated (Total Keys: 1) --- docs/dyn/drive_v2.files.html | 8 +- docs/dyn/drive_v3.changes.html | 72 +- docs/dyn/drive_v3.drives.html | 16 +- docs/dyn/drive_v3.files.html | 676 +++++++++--------- docs/dyn/drive_v3.permissions.html | 2 +- docs/dyn/drive_v3.teamdrives.html | 12 +- .../discovery_cache/documents/drive.v2.json | 6 +- .../discovery_cache/documents/drive.v3.json | 166 ++--- 8 files changed, 480 insertions(+), 478 deletions(-) diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html index ec89a0c2806..f331274a7b4 100644 --- a/docs/dyn/drive_v2.files.html +++ b/docs/dyn/drive_v2.files.html @@ -106,7 +106,7 @@

Instance Methods

Inserts a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.

list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)

-

Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.

+

Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.

listLabels(fileId, maxResults=None, pageToken=None, x__xgafv=None)

Lists the labels on a file.

@@ -133,7 +133,7 @@

Instance Methods

Restores a file from the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files.

update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, x__xgafv=None)

-

Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).

+

Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).

watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None, x__xgafv=None)

Subscribes to changes to a file.

@@ -2275,7 +2275,7 @@

Method Details

list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None) -
 Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.
+  
 Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.
 
 Args:
   corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are `default`, `domain`, `drive` and `allDrives`. Prefer `default` or `drive` to `allDrives` for efficiency.
@@ -4912,7 +4912,7 @@ 

Method Details

update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, x__xgafv=None) -
 Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).
+  
 Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).
 
 Args:
   fileId: string, The ID of the file to update. (required)
diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html
index 85e85af4be8..eccf95d4677 100644
--- a/docs/dyn/drive_v3.changes.html
+++ b/docs/dyn/drive_v3.changes.html
@@ -193,7 +193,7 @@ 

Method Details

"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. @@ -206,56 +206,56 @@

Method Details

# Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. "a_key": "A String", }, - "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. + "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. "canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. - "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. "canChangeViewersCanCopyContent": True or False, # Deprecated: Output only. "canComment": True or False, # Output only. Whether the current user can comment on this file. - "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. + "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. - "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. - "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. + "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. "canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. "canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted. - "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. - "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. "canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. "canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. + "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. "canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. + "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. "canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead. "canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. - "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead. - "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. - "canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user. "canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. "canRename": True or False, # Output only. Whether the current user can rename this file. "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. "canTrash": True or False, # Output only. Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. - "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements. + "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. - "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + "image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). "mimeType": "A String", # The MIME type of the thumbnail. }, }, @@ -264,7 +264,7 @@

Method Details

"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. - "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. @@ -277,17 +277,17 @@

Method Details

"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], - "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters. "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time). "description": "A String", # A short description of the file. "downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file. "effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, - "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, }, "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. @@ -296,10 +296,10 @@

Method Details

"a_key": "A String", }, "fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. - "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. - "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. + "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. "headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. "iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon. "id": "A String", # The ID of the file. @@ -384,11 +384,11 @@

Method Details

"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. - "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. "modifiedByMe": True or False, # Output only. Whether the file has been modified by this user. "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time). "modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. - "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + "name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. "ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives. "owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. @@ -447,8 +447,8 @@

Method Details

}, "quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. - "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time). "sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable. @@ -462,15 +462,15 @@

Method Details

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. "targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests. "targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. - "targetResourceKey": "A String", # Output only. The ResourceKey for the target file. + "targetResourceKey": "A String", # Output only. The `resourceKey` for the target file. }, - "size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. - "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + "size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. + "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. "A String", ], "starred": True or False, # Whether the user has starred the file. "teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. - "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. @@ -542,7 +542,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. diff --git a/docs/dyn/drive_v3.drives.html b/docs/dyn/drive_v3.drives.html index f67b77adebd..d4f84e46fd7 100644 --- a/docs/dyn/drive_v3.drives.html +++ b/docs/dyn/drive_v3.drives.html @@ -160,7 +160,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. @@ -220,7 +220,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. @@ -303,7 +303,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. @@ -370,7 +370,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. @@ -442,7 +442,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. @@ -527,7 +527,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. @@ -589,7 +589,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. @@ -650,7 +650,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html index af90854c012..3411ac555f0 100644 --- a/docs/dyn/drive_v3.files.html +++ b/docs/dyn/drive_v3.files.html @@ -79,40 +79,40 @@

Instance Methods

Close httplib2 connections.

copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)

-

Creates a copy of a file and applies any requested updates with patch semantics.

+

Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).

create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None)

-

Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.

+

Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.

delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)

-

Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.

+

Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.

download(fileId, mimeType=None, revisionId=None, x__xgafv=None)

-

Downloads content of a file. Operations are valid for 24 hours from the time of creation.

+

Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.

emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None)

-

Permanently deletes all of the user's trashed files.

+

Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).

export(fileId, mimeType, x__xgafv=None)

-

Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.

+

Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.

export_media(fileId, mimeType, x__xgafv=None)

-

Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.

+

Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.

generateIds(count=None, space=None, type=None, x__xgafv=None)

-

Generates a set of file IDs which can be provided in create or copy requests.

+

Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).

get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)

-

Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads).

+

Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).

get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)

-

Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads).

+

Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).

list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)

-

Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.

+

Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.

listLabels(fileId, maxResults=None, pageToken=None, x__xgafv=None)

-

Lists the labels on a file.

+

Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).

listLabels_next()

Retrieves the next page of results.

@@ -121,13 +121,13 @@

Instance Methods

Retrieves the next page of results.

modifyLabels(fileId, body=None, x__xgafv=None)

-

Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.

+

Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.

update(fileId, addParents=None, body=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None)

-

Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).

+

Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).

watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)

-

Subscribes to changes to a file.

+

Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).

Method Details

close() @@ -136,7 +136,7 @@

Method Details

copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None) -
Creates a copy of a file and applies any requested updates with patch semantics.
+  
Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).
 
 Args:
   fileId: string, The ID of the file. (required)
@@ -148,56 +148,56 @@ 

Method Details

# Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. "a_key": "A String", }, - "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. + "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. "canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. - "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. "canChangeViewersCanCopyContent": True or False, # Deprecated: Output only. "canComment": True or False, # Output only. Whether the current user can comment on this file. - "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. + "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. - "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. - "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. + "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. "canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. "canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted. - "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. - "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. "canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. "canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. + "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. "canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. + "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. "canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead. "canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. - "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead. - "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. - "canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user. "canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. "canRename": True or False, # Output only. Whether the current user can rename this file. "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. "canTrash": True or False, # Output only. Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. - "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements. + "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. - "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + "image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). "mimeType": "A String", # The MIME type of the thumbnail. }, }, @@ -206,7 +206,7 @@

Method Details

"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. - "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. @@ -219,17 +219,17 @@

Method Details

"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], - "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters. "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time). "description": "A String", # A short description of the file. "downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file. "effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, - "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, }, "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. @@ -238,10 +238,10 @@

Method Details

"a_key": "A String", }, "fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. - "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. - "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. + "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. "headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. "iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon. "id": "A String", # The ID of the file. @@ -326,11 +326,11 @@

Method Details

"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. - "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. "modifiedByMe": True or False, # Output only. Whether the file has been modified by this user. "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time). "modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. - "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + "name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. "ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives. "owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. @@ -389,8 +389,8 @@

Method Details

}, "quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. - "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time). "sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable. @@ -404,15 +404,15 @@

Method Details

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. "targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests. "targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. - "targetResourceKey": "A String", # Output only. The ResourceKey for the target file. + "targetResourceKey": "A String", # Output only. The `resourceKey` for the target file. }, - "size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. - "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + "size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. + "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. "A String", ], "starred": True or False, # Whether the user has starred the file. "teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. - "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. @@ -438,11 +438,11 @@

Method Details

"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives. } - enforceSingleParent: boolean, Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead. + enforceSingleParent: boolean, Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead. ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. - keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. + keepRevisionForever: boolean, Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code). supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. @@ -459,56 +459,56 @@

Method Details

# Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. "a_key": "A String", }, - "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. + "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. "canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. - "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. "canChangeViewersCanCopyContent": True or False, # Deprecated: Output only. "canComment": True or False, # Output only. Whether the current user can comment on this file. - "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. + "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. - "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. - "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. + "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. "canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. "canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted. - "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. - "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. "canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. "canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. + "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. "canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. + "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. "canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead. "canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. - "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead. - "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. - "canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user. "canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. "canRename": True or False, # Output only. Whether the current user can rename this file. "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. "canTrash": True or False, # Output only. Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. - "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements. + "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. - "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + "image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). "mimeType": "A String", # The MIME type of the thumbnail. }, }, @@ -517,7 +517,7 @@

Method Details

"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. - "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. @@ -530,17 +530,17 @@

Method Details

"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], - "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters. "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time). "description": "A String", # A short description of the file. "downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file. "effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, - "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, }, "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. @@ -549,10 +549,10 @@

Method Details

"a_key": "A String", }, "fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. - "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. - "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. + "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. "headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. "iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon. "id": "A String", # The ID of the file. @@ -637,11 +637,11 @@

Method Details

"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. - "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. "modifiedByMe": True or False, # Output only. Whether the file has been modified by this user. "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time). "modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. - "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + "name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. "ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives. "owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. @@ -700,8 +700,8 @@

Method Details

}, "quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. - "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time). "sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable. @@ -715,15 +715,15 @@

Method Details

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. "targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests. "targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. - "targetResourceKey": "A String", # Output only. The ResourceKey for the target file. + "targetResourceKey": "A String", # Output only. The `resourceKey` for the target file. }, - "size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. - "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + "size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. + "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. "A String", ], "starred": True or False, # Whether the user has starred the file. "teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. - "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. @@ -752,7 +752,7 @@

Method Details

create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None) -
 Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.
+  
 Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.
 
 Args:
   body: object, The request body.
@@ -763,56 +763,56 @@ 

Method Details

# Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. "a_key": "A String", }, - "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. + "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. "canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. - "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. "canChangeViewersCanCopyContent": True or False, # Deprecated: Output only. "canComment": True or False, # Output only. Whether the current user can comment on this file. - "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. + "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. - "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. - "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. + "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. "canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. "canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted. - "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. - "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. "canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. "canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. + "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. "canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. + "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. "canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead. "canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. - "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead. - "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. - "canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user. "canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. "canRename": True or False, # Output only. Whether the current user can rename this file. "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. "canTrash": True or False, # Output only. Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. - "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements. + "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. - "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + "image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). "mimeType": "A String", # The MIME type of the thumbnail. }, }, @@ -821,7 +821,7 @@

Method Details

"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. - "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. @@ -834,17 +834,17 @@

Method Details

"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], - "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters. "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time). "description": "A String", # A short description of the file. "downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file. "effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, - "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, }, "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. @@ -853,10 +853,10 @@

Method Details

"a_key": "A String", }, "fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. - "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. - "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. + "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. "headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. "iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon. "id": "A String", # The ID of the file. @@ -941,11 +941,11 @@

Method Details

"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. - "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. "modifiedByMe": True or False, # Output only. Whether the file has been modified by this user. "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time). "modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. - "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + "name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. "ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives. "owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. @@ -1004,8 +1004,8 @@

Method Details

}, "quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. - "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time). "sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable. @@ -1019,15 +1019,15 @@

Method Details

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. "targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests. "targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. - "targetResourceKey": "A String", # Output only. The ResourceKey for the target file. + "targetResourceKey": "A String", # Output only. The `resourceKey` for the target file. }, - "size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. - "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + "size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. + "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. "A String", ], "starred": True or False, # Whether the user has starred the file. "teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. - "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. @@ -1053,11 +1053,11 @@

Method Details

"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives. } - enforceSingleParent: boolean, Deprecated. Creating files in multiple folders is no longer supported. + enforceSingleParent: boolean, Deprecated: Creating files in multiple folders is no longer supported. ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. - keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. + keepRevisionForever: boolean, Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code). @@ -1077,56 +1077,56 @@

Method Details

# Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. "a_key": "A String", }, - "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. + "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. "canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. - "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. "canChangeViewersCanCopyContent": True or False, # Deprecated: Output only. "canComment": True or False, # Output only. Whether the current user can comment on this file. - "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. + "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. - "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. - "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. + "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. "canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. "canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted. - "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. - "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. "canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. "canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. + "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. "canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. + "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. "canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead. "canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. - "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead. - "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. - "canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user. "canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. "canRename": True or False, # Output only. Whether the current user can rename this file. "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. "canTrash": True or False, # Output only. Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. - "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements. + "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. - "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + "image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). "mimeType": "A String", # The MIME type of the thumbnail. }, }, @@ -1135,7 +1135,7 @@

Method Details

"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. - "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. @@ -1148,17 +1148,17 @@

Method Details

"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], - "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters. "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time). "description": "A String", # A short description of the file. "downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file. "effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, - "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, }, "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. @@ -1167,10 +1167,10 @@

Method Details

"a_key": "A String", }, "fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. - "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. - "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. + "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. "headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. "iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon. "id": "A String", # The ID of the file. @@ -1255,11 +1255,11 @@

Method Details

"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. - "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. "modifiedByMe": True or False, # Output only. Whether the file has been modified by this user. "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time). "modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. - "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + "name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. "ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives. "owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. @@ -1318,8 +1318,8 @@

Method Details

}, "quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. - "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time). "sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable. @@ -1333,15 +1333,15 @@

Method Details

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. "targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests. "targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. - "targetResourceKey": "A String", # Output only. The ResourceKey for the target file. + "targetResourceKey": "A String", # Output only. The `resourceKey` for the target file. }, - "size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. - "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + "size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. + "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. "A String", ], "starred": True or False, # Whether the user has starred the file. "teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. - "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. @@ -1370,11 +1370,11 @@

Method Details

delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None) -
Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.
+  
Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.
 
 Args:
   fileId: string, The ID of the file. (required)
-  enforceSingleParent: boolean, Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.
+  enforceSingleParent: boolean, Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
   x__xgafv: string, V1 error format.
@@ -1386,11 +1386,11 @@ 

Method Details

download(fileId, mimeType=None, revisionId=None, x__xgafv=None) -
Downloads content of a file. Operations are valid for 24 hours from the time of creation.
+  
Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.
 
 Args:
   fileId: string, Required. The ID of the file to download. (required)
-  mimeType: string, Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.
+  mimeType: string, Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.
   revisionId: string, Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1423,11 +1423,11 @@ 

Method Details

emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None) -
Permanently deletes all of the user's trashed files.
+  
Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).
 
 Args:
   driveId: string, If set, empties the trash of the provided shared drive.
-  enforceSingleParent: boolean, Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.
+  enforceSingleParent: boolean, Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1437,11 +1437,11 @@ 

Method Details

export(fileId, mimeType, x__xgafv=None) -
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
+  
Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.
 
 Args:
   fileId: string, The ID of the file. (required)
-  mimeType: string, Required. The MIME type of the format requested for this export. (required)
+  mimeType: string, Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1451,11 +1451,11 @@ 

Method Details

export_media(fileId, mimeType, x__xgafv=None) -
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
+  
Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.
 
 Args:
   fileId: string, The ID of the file. (required)
-  mimeType: string, Required. The MIME type of the format requested for this export. (required)
+  mimeType: string, Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1465,12 +1465,12 @@ 

Method Details

generateIds(count=None, space=None, type=None, x__xgafv=None) -
Generates a set of file IDs which can be provided in create or copy requests.
+  
Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).
 
 Args:
   count: integer, The number of IDs to return.
-  space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive')
-  type: string, The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the `drive` 'space'. (Default: 'files')
+  space: string, The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
+  type: string, The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1490,13 +1490,13 @@ 

Method Details

get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None) -
 Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads).
+  
 Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).
 
 Args:
   fileId: string, The ID of the file. (required)
   acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
   includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
-  includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
+  includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
   x__xgafv: string, V1 error format.
@@ -1512,56 +1512,56 @@ 

Method Details

# Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. "a_key": "A String", }, - "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. + "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. "canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. - "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. "canChangeViewersCanCopyContent": True or False, # Deprecated: Output only. "canComment": True or False, # Output only. Whether the current user can comment on this file. - "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. + "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. - "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. - "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. + "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. "canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. "canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted. - "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. - "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. "canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. "canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. + "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. "canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. + "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. "canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead. "canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. - "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead. - "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. - "canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user. "canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. "canRename": True or False, # Output only. Whether the current user can rename this file. "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. "canTrash": True or False, # Output only. Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. - "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements. + "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. - "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + "image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). "mimeType": "A String", # The MIME type of the thumbnail. }, }, @@ -1570,7 +1570,7 @@

Method Details

"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. - "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. @@ -1583,17 +1583,17 @@

Method Details

"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], - "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters. "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time). "description": "A String", # A short description of the file. "downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file. "effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, - "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, }, "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. @@ -1602,10 +1602,10 @@

Method Details

"a_key": "A String", }, "fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. - "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. - "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. + "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. "headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. "iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon. "id": "A String", # The ID of the file. @@ -1690,11 +1690,11 @@

Method Details

"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. - "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. "modifiedByMe": True or False, # Output only. Whether the file has been modified by this user. "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time). "modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. - "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + "name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. "ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives. "owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. @@ -1753,8 +1753,8 @@

Method Details

}, "quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. - "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time). "sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable. @@ -1768,15 +1768,15 @@

Method Details

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. "targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests. "targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. - "targetResourceKey": "A String", # Output only. The ResourceKey for the target file. + "targetResourceKey": "A String", # Output only. The `resourceKey` for the target file. }, - "size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. - "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + "size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. + "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. "A String", ], "starred": True or False, # Whether the user has starred the file. "teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. - "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. @@ -1805,13 +1805,13 @@

Method Details

get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None) -
 Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads).
+  
 Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).
 
 Args:
   fileId: string, The ID of the file. (required)
   acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
   includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
-  includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
+  includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
   x__xgafv: string, V1 error format.
@@ -1827,24 +1827,24 @@ 

Method Details

list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None) -
 Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.
+  
 Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.
 
 Args:
-  corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.
-  corpus: string, Deprecated: The source of files to list. Use 'corpora' instead.
+  corpora: string, Bodies of items (files or documents) to which the query applies. Supported bodies are: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
+  corpus: string, Deprecated: The source of files to list. Use `corpora` instead.
     Allowed values
       domain - Files shared to the user's domain.
       user - Files owned by or shared to the user.
   driveId: string, ID of the shared drive to search.
   includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
   includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
-  includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
+  includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
   includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead.
-  orderBy: string, A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.
+  orderBy: string, A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.
   pageSize: integer, The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
-  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
-  q: string, A query for filtering the file results. See the "Search for files & folders" guide for supported syntax.
-  spaces: string, A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.
+  q: string, A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).
+  spaces: string, A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
   teamDriveId: string, Deprecated: Use `driveId` instead.
@@ -1857,62 +1857,62 @@ 

Method Details

An object of the form: { # A list of files. - "files": [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. + "files": [ # The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. { # The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file. "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app. # Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. "a_key": "A String", }, - "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. + "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. "canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. - "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. "canChangeViewersCanCopyContent": True or False, # Deprecated: Output only. "canComment": True or False, # Output only. Whether the current user can comment on this file. - "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. + "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. - "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. - "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. + "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. "canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. "canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted. - "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. - "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. "canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. "canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. + "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. "canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. + "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. "canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead. "canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. - "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead. - "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. - "canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user. "canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. "canRename": True or False, # Output only. Whether the current user can rename this file. "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. "canTrash": True or False, # Output only. Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. - "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements. + "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. - "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + "image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). "mimeType": "A String", # The MIME type of the thumbnail. }, }, @@ -1921,7 +1921,7 @@

Method Details

"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. - "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. @@ -1934,17 +1934,17 @@

Method Details

"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], - "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters. "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time). "description": "A String", # A short description of the file. "downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file. "effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, - "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, }, "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. @@ -1953,10 +1953,10 @@

Method Details

"a_key": "A String", }, "fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. - "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. - "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. + "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. "headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. "iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon. "id": "A String", # The ID of the file. @@ -2041,11 +2041,11 @@

Method Details

"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. - "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. "modifiedByMe": True or False, # Output only. Whether the file has been modified by this user. "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time). "modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. - "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + "name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. "ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives. "owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. @@ -2104,8 +2104,8 @@

Method Details

}, "quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. - "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time). "sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable. @@ -2119,15 +2119,15 @@

Method Details

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. "targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests. "targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. - "targetResourceKey": "A String", # Output only. The ResourceKey for the target file. + "targetResourceKey": "A String", # Output only. The `resourceKey` for the target file. }, - "size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. - "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + "size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. + "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. "A String", ], "starred": True or False, # Whether the user has starred the file. "teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. - "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. @@ -2153,7 +2153,7 @@

Method Details

"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives. }, ], - "incompleteSearch": True or False, # Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the 'allDrives' corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as 'user' or 'drive'. + "incompleteSearch": True or False, # Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`. "kind": "drive#fileList", # Identifies what kind of resource this is. Value: the fixed string `"drive#fileList"`. "nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. }
@@ -2161,12 +2161,12 @@

Method Details

listLabels(fileId, maxResults=None, pageToken=None, x__xgafv=None) -
Lists the labels on a file.
+  
Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).
 
 Args:
   fileId: string, The ID for the file. (required)
   maxResults: integer, The maximum number of labels to return per page. When not set, defaults to 100.
-  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -2176,7 +2176,7 @@ 

Method Details

An object of the form: { # A list of labels applied to a file. - "kind": "A String", # This is always drive#labelList + "kind": "A String", # This is always `"drive#labelList"`. "labels": [ # The list of labels. { # Representation of label and label fields. "fields": { # A map of the fields on the label, keyed by the field's ID. @@ -2247,7 +2247,7 @@

Method Details

modifyLabels(fileId, body=None, x__xgafv=None) -
Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.
+  
Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.
 
 Args:
   fileId: string, The ID of the file to which the labels belong. (required)
@@ -2255,13 +2255,13 @@ 

Method Details

The object takes the form of: { # A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically. - "kind": "A String", # This is always drive#modifyLabelsRequest. + "kind": "A String", # This is always `"drive#modifyLabelsRequest"`. "labelModifications": [ # The list of modifications to apply to the labels on the file. - { # A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file. + { # A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file. "fieldModifications": [ # The list of modifications to this label's fields. { # A modification to a label's field. "fieldId": "A String", # The ID of the field to be modified. - "kind": "A String", # This is always drive#labelFieldModification. + "kind": "A String", # This is always `"drive#labelFieldModification"`. "setDateValues": [ # Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD. "A String", ], @@ -2274,13 +2274,13 @@

Method Details

"setTextValues": [ # Sets the value of a `text` field. "A String", ], - "setUserValues": [ # Replaces a `user` field with these new values. The values must be valid email addresses. + "setUserValues": [ # Replaces a `user` field with these new values. The values must be a valid email addresses. "A String", ], "unsetValues": True or False, # Unsets the values for this field. }, ], - "kind": "A String", # This is always drive#labelModification. + "kind": "A String", # This is always `"drive#labelModification"`. "labelId": "A String", # The ID of the label to modify. "removeLabel": True or False, # If true, the label will be removed from the file. }, @@ -2295,8 +2295,8 @@

Method Details

Returns: An object of the form: - { # Response to a ModifyLabels request. This contains only those labels which were added or updated by the request. - "kind": "A String", # This is always drive#modifyLabelsResponse + { # Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request. + "kind": "A String", # This is always `"drive#modifyLabelsResponse"`. "modifiedLabels": [ # The list of labels which were added or updated by the request. { # Representation of label and label fields. "fields": { # A map of the fields on the label, keyed by the field's ID. @@ -2338,7 +2338,7 @@

Method Details

update(fileId, addParents=None, body=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None) -
 Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).
+  
 Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).
 
 Args:
   fileId: string, The ID of the file. (required)
@@ -2350,56 +2350,56 @@ 

Method Details

# Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. "a_key": "A String", }, - "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. + "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. "canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. - "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. "canChangeViewersCanCopyContent": True or False, # Deprecated: Output only. "canComment": True or False, # Output only. Whether the current user can comment on this file. - "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. + "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. - "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. - "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. + "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. "canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. "canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted. - "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. - "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. "canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. "canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. + "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. "canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. + "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. "canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead. "canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. - "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead. - "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. - "canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user. "canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. "canRename": True or False, # Output only. Whether the current user can rename this file. "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. "canTrash": True or False, # Output only. Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. - "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements. + "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. - "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + "image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). "mimeType": "A String", # The MIME type of the thumbnail. }, }, @@ -2408,7 +2408,7 @@

Method Details

"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. - "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. @@ -2421,17 +2421,17 @@

Method Details

"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], - "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters. "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time). "description": "A String", # A short description of the file. "downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file. "effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, - "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, }, "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. @@ -2440,10 +2440,10 @@

Method Details

"a_key": "A String", }, "fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. - "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. - "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. + "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. "headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. "iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon. "id": "A String", # The ID of the file. @@ -2528,11 +2528,11 @@

Method Details

"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. - "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. "modifiedByMe": True or False, # Output only. Whether the file has been modified by this user. "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time). "modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. - "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + "name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. "ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives. "owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. @@ -2591,8 +2591,8 @@

Method Details

}, "quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. - "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time). "sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable. @@ -2606,15 +2606,15 @@

Method Details

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. "targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests. "targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. - "targetResourceKey": "A String", # Output only. The ResourceKey for the target file. + "targetResourceKey": "A String", # Output only. The `resourceKey` for the target file. }, - "size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. - "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + "size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. + "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. "A String", ], "starred": True or False, # Whether the user has starred the file. "teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. - "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. @@ -2643,8 +2643,8 @@

Method Details

addParents: string, A comma-separated list of parent IDs to add. enforceSingleParent: boolean, Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. - keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. + keepRevisionForever: boolean, Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code). @@ -2665,56 +2665,56 @@

Method Details

# Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. "a_key": "A String", }, - "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. + "canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. "canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. - "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. "canChangeViewersCanCopyContent": True or False, # Deprecated: Output only. "canComment": True or False, # Output only. Whether the current user can comment on this file. - "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. + "canCopy": True or False, # Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. "canDelete": True or False, # Output only. Whether the current user can delete this file. - "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions. "canDownload": True or False, # Output only. Whether the current user can download this file. "canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. "canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions. - "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`. + "canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. "canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. "canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted. - "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. - "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. "canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. "canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. + "canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. "canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. - "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. + "canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. "canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead. "canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. - "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead. - "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. - "canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user. "canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. "canRename": True or False, # Output only. Whether the current user can rename this file. "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. "canTrash": True or False, # Output only. Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. - "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements. + "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. - "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + "image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). "mimeType": "A String", # The MIME type of the thumbnail. }, }, @@ -2723,7 +2723,7 @@

Method Details

"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. - "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. @@ -2736,17 +2736,17 @@

Method Details

"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], - "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. + "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters. "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time). "description": "A String", # A short description of the file. "downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file. "effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, - "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules. + "itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, }, "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. @@ -2755,10 +2755,10 @@

Method Details

"a_key": "A String", }, "fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. - "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead. - "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension. + "folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. + "fullFileExtension": "A String", # Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. + "hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. "headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. "iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon. "id": "A String", # The ID of the file. @@ -2843,11 +2843,11 @@

Method Details

"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. - "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource. + "mimeType": "A String", # The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. "modifiedByMe": True or False, # Output only. Whether the file has been modified by this user. "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time). "modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. - "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. + "name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. "ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives. "owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. @@ -2906,8 +2906,8 @@

Method Details

}, "quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. - "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time). "sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable. @@ -2921,15 +2921,15 @@

Method Details

"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. "targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests. "targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. - "targetResourceKey": "A String", # Output only. The ResourceKey for the target file. + "targetResourceKey": "A String", # Output only. The `resourceKey` for the target file. }, - "size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. - "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. + "size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. + "spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. "A String", ], "starred": True or False, # Whether the user has starred the file. "teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. - "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. @@ -2958,7 +2958,7 @@

Method Details

watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None) -
Subscribes to changes to a file.
+  
Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).
 
 Args:
   fileId: string, The ID of the file. (required)
@@ -2982,7 +2982,7 @@ 

Method Details

acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. x__xgafv: string, V1 error format. diff --git a/docs/dyn/drive_v3.permissions.html b/docs/dyn/drive_v3.permissions.html index 5f4a994c1d1..07ae86babc6 100644 --- a/docs/dyn/drive_v3.permissions.html +++ b/docs/dyn/drive_v3.permissions.html @@ -147,7 +147,7 @@

Method Details

enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules. enforceSingleParent: boolean, Deprecated: See `moveToNewOwnersRoot` for details. moveToNewOwnersRoot: boolean, This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed. - 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. + sendNotificationEmail: boolean, Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. diff --git a/docs/dyn/drive_v3.teamdrives.html b/docs/dyn/drive_v3.teamdrives.html index ec89f0b2b97..898c3dcc696 100644 --- a/docs/dyn/drive_v3.teamdrives.html +++ b/docs/dyn/drive_v3.teamdrives.html @@ -154,7 +154,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. @@ -214,7 +214,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. @@ -295,7 +295,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. @@ -369,7 +369,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. @@ -447,7 +447,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. @@ -508,7 +508,7 @@

Method Details

"domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. "downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers. "restrictedForReaders": True or False, # Whether download and copy is restricted for readers. - "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers. + "restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. }, "sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 594589d6d90..cbd4363bcf4 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -1696,7 +1696,7 @@ "supportsMediaUpload": true }, "list": { -"description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", +"description": " Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", "flatPath": "files", "httpMethod": "GET", "id": "drive.files.list", @@ -2202,7 +2202,7 @@ ] }, "update": { -"description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", +"description": " Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", "flatPath": "files/{fileId}", "httpMethod": "PUT", "id": "drive.files.update", @@ -3893,7 +3893,7 @@ } } }, -"revision": "20250826", +"revision": "20250829", "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 389f7b4a6ba..680ea7398a8 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -1047,7 +1047,7 @@ "files": { "methods": { "copy": { -"description": "Creates a copy of a file and applies any requested updates with patch semantics.", +"description": "Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).", "flatPath": "files/{fileId}/copy", "httpMethod": "POST", "id": "drive.files.copy", @@ -1057,7 +1057,8 @@ "parameters": { "enforceSingleParent": { "default": "false", -"description": "Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.", +"deprecated": true, +"description": "Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -1079,13 +1080,13 @@ "type": "string" }, "includePermissionsForView": { -"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", +"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "keepRevisionForever": { "default": "false", -"description": "Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", +"description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", "location": "query", "type": "boolean" }, @@ -1123,7 +1124,7 @@ ] }, "create": { -"description": " Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", +"description": " Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", "flatPath": "files", "httpMethod": "POST", "id": "drive.files.create", @@ -1147,7 +1148,8 @@ "parameters": { "enforceSingleParent": { "default": "false", -"description": "Deprecated. Creating files in multiple folders is no longer supported.", +"deprecated": true, +"description": "Deprecated: Creating files in multiple folders is no longer supported.", "location": "query", "type": "boolean" }, @@ -1163,13 +1165,13 @@ "type": "string" }, "includePermissionsForView": { -"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", +"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "keepRevisionForever": { "default": "false", -"description": "Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", +"description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", "location": "query", "type": "boolean" }, @@ -1213,7 +1215,7 @@ "supportsMediaUpload": true }, "delete": { -"description": "Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.", +"description": "Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.", "flatPath": "files/{fileId}", "httpMethod": "DELETE", "id": "drive.files.delete", @@ -1224,7 +1226,7 @@ "enforceSingleParent": { "default": "false", "deprecated": true, -"description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", +"description": "Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -1256,7 +1258,7 @@ ] }, "download": { -"description": "Downloads content of a file. Operations are valid for 24 hours from the time of creation.", +"description": "Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.", "flatPath": "files/{fileId}/download", "httpMethod": "POST", "id": "drive.files.download", @@ -1271,7 +1273,7 @@ "type": "string" }, "mimeType": { -"description": "Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.", +"description": "Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.", "location": "query", "type": "string" }, @@ -1292,7 +1294,7 @@ ] }, "emptyTrash": { -"description": "Permanently deletes all of the user's trashed files.", +"description": "Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).", "flatPath": "files/trash", "httpMethod": "DELETE", "id": "drive.files.emptyTrash", @@ -1306,7 +1308,7 @@ "enforceSingleParent": { "default": "false", "deprecated": true, -"description": "Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", +"description": "Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.", "location": "query", "type": "boolean" } @@ -1317,7 +1319,7 @@ ] }, "export": { -"description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", +"description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.", "flatPath": "files/{fileId}/export", "httpMethod": "GET", "id": "drive.files.export", @@ -1333,7 +1335,7 @@ "type": "string" }, "mimeType": { -"description": "Required. The MIME type of the format requested for this export.", +"description": "Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).", "location": "query", "required": true, "type": "string" @@ -1350,7 +1352,7 @@ "useMediaDownloadService": true }, "generateIds": { -"description": "Generates a set of file IDs which can be provided in create or copy requests.", +"description": "Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).", "flatPath": "files/generateIds", "httpMethod": "GET", "id": "drive.files.generateIds", @@ -1367,13 +1369,13 @@ }, "space": { "default": "drive", -"description": "The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive')", +"description": "The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "location": "query", "type": "string" }, "type": { "default": "files", -"description": "The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the `drive` 'space'. (Default: 'files')", +"description": "The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "location": "query", "type": "string" } @@ -1389,7 +1391,7 @@ ] }, "get": { -"description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads).", +"description": " Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).", "flatPath": "files/{fileId}", "httpMethod": "GET", "id": "drive.files.get", @@ -1415,7 +1417,7 @@ "type": "string" }, "includePermissionsForView": { -"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", +"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -1452,20 +1454,20 @@ "useMediaDownloadService": true }, "list": { -"description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", +"description": " Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", "flatPath": "files", "httpMethod": "GET", "id": "drive.files.list", "parameterOrder": [], "parameters": { "corpora": { -"description": "Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.", +"description": "Bodies of items (files or documents) to which the query applies. Supported bodies are: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "location": "query", "type": "string" }, "corpus": { "deprecated": true, -"description": "Deprecated: The source of files to list. Use 'corpora' instead.", +"description": "Deprecated: The source of files to list. Use `corpora` instead.", "enum": [ "domain", "user" @@ -1494,7 +1496,7 @@ "type": "string" }, "includePermissionsForView": { -"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", +"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -1506,7 +1508,7 @@ "type": "boolean" }, "orderBy": { -"description": "A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.", +"description": "A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.", "location": "query", "type": "string" }, @@ -1520,18 +1522,18 @@ "type": "integer" }, "pageToken": { -"description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", +"description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.", "location": "query", "type": "string" }, "q": { -"description": "A query for filtering the file results. See the \"Search for files & folders\" guide for supported syntax.", +"description": "A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).", "location": "query", "type": "string" }, "spaces": { "default": "drive", -"description": "A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.", +"description": "A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).", "location": "query", "type": "string" }, @@ -1571,7 +1573,7 @@ ] }, "listLabels": { -"description": "Lists the labels on a file.", +"description": "Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).", "flatPath": "files/{fileId}/listLabels", "httpMethod": "GET", "id": "drive.files.listLabels", @@ -1595,7 +1597,7 @@ "type": "integer" }, "pageToken": { -"description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", +"description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.", "location": "query", "type": "string" } @@ -1614,7 +1616,7 @@ ] }, "modifyLabels": { -"description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.", +"description": "Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.", "flatPath": "files/{fileId}/modifyLabels", "httpMethod": "POST", "id": "drive.files.modifyLabels", @@ -1643,7 +1645,7 @@ ] }, "update": { -"description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", +"description": " Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", "flatPath": "files/{fileId}", "httpMethod": "PATCH", "id": "drive.files.update", @@ -1691,13 +1693,13 @@ "type": "string" }, "includePermissionsForView": { -"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", +"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, "keepRevisionForever": { "default": "false", -"description": "Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", +"description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.", "location": "query", "type": "boolean" }, @@ -1748,7 +1750,7 @@ "supportsMediaUpload": true }, "watch": { -"description": "Subscribes to changes to a file.", +"description": "Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "flatPath": "files/{fileId}/watch", "httpMethod": "POST", "id": "drive.files.watch", @@ -1774,7 +1776,7 @@ "type": "string" }, "includePermissionsForView": { -"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", +"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.", "location": "query", "type": "string" }, @@ -1887,7 +1889,7 @@ "type": "boolean" }, "sendNotificationEmail": { -"description": "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.", +"description": "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.", "location": "query", "type": "boolean" }, @@ -2718,7 +2720,7 @@ } } }, -"revision": "20250819", +"revision": "20250829", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3337,7 +3339,7 @@ }, "restrictingUser": { "$ref": "User", -"description": "Output only. The user who set the content restriction. Only populated if `readOnly` is true." +"description": "Output only. The user who set the content restriction. Only populated if `readOnly=true`." }, "restrictionTime": { "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", @@ -3364,7 +3366,7 @@ "type": "boolean" }, "restrictedForWriters": { -"description": "Whether download and copy is restricted for writers. If true, download is also restricted for readers.", +"description": "Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.", "type": "boolean" } }, @@ -3380,7 +3382,7 @@ }, "itemDownloadRestriction": { "$ref": "DownloadRestriction", -"description": "The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules." +"description": "The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules." } }, "type": "object" @@ -3610,18 +3612,18 @@ "type": "object" }, "capabilities": { -"description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", +"description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).", "properties": { "canAcceptOwnership": { "description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "canAddChildren": { -"description": "Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.", +"description": "Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.", "type": "boolean" }, "canAddFolderFromAnotherDrive": { -"description": "Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.", +"description": "Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canAddMyDriveParent": { @@ -3637,7 +3639,7 @@ "type": "boolean" }, "canChangeSecurityUpdateEnabled": { -"description": "Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.", +"description": "Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.", "type": "boolean" }, "canChangeViewersCanCopyContent": { @@ -3650,7 +3652,7 @@ "type": "boolean" }, "canCopy": { -"description": "Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.", +"description": "Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder.", "type": "boolean" }, "canDelete": { @@ -3658,7 +3660,7 @@ "type": "boolean" }, "canDeleteChildren": { -"description": "Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", +"description": "Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canDisableInheritedPermissions": { @@ -3678,7 +3680,7 @@ "type": "boolean" }, "canListChildren": { -"description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", +"description": "Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.", "type": "boolean" }, "canModifyContent": { @@ -3687,7 +3689,7 @@ }, "canModifyContentRestriction": { "deprecated": true, -"description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.", +"description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.", "type": "boolean" }, "canModifyEditorContentRestriction": { @@ -3703,7 +3705,7 @@ "type": "boolean" }, "canMoveChildrenOutOfDrive": { -"description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", +"description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { @@ -3712,7 +3714,7 @@ "type": "boolean" }, "canMoveChildrenWithinDrive": { -"description": "Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.", +"description": "Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.", "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { @@ -3726,7 +3728,7 @@ "type": "boolean" }, "canMoveItemOutOfDrive": { -"description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.", +"description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added.", "type": "boolean" }, "canMoveItemOutOfTeamDrive": { @@ -3735,7 +3737,7 @@ "type": "boolean" }, "canMoveItemWithinDrive": { -"description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.", +"description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { @@ -3757,7 +3759,7 @@ "type": "boolean" }, "canReadRevisions": { -"description": "Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.", +"description": "Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read.", "type": "boolean" }, "canReadTeamDrive": { @@ -3766,11 +3768,11 @@ "type": "boolean" }, "canRemoveChildren": { -"description": "Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.", +"description": "Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.", "type": "boolean" }, "canRemoveContentRestriction": { -"description": "Output only. Whether there is a content restriction on the file that can be removed by the current user.", +"description": "Output only. Whether there's a content restriction on the file that can be removed by the current user.", "type": "boolean" }, "canRemoveMyDriveParent": { @@ -3790,7 +3792,7 @@ "type": "boolean" }, "canTrashChildren": { -"description": "Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", +"description": "Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.", "type": "boolean" }, "canUntrash": { @@ -3804,14 +3806,14 @@ "description": "Additional information about the content of the file. These fields are never populated in responses.", "properties": { "indexableText": { -"description": "Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.", +"description": "Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements.", "type": "string" }, "thumbnail": { "description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.", "properties": { "image": { -"description": "The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).", +"description": "The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).", "format": "byte", "type": "string" }, @@ -3833,7 +3835,7 @@ "type": "array" }, "copyRequiresWriterPermission": { -"description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters.", +"description": "Whether the options to copy, print, or download this file should be disabled for readers and commenters.", "type": "boolean" }, "createdTime": { @@ -3870,11 +3872,11 @@ "type": "string" }, "folderColorRgb": { -"description": "The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the About resource. If an unsupported color is specified, the closest color in the palette is used instead.", +"description": "The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.", "type": "string" }, "fullFileExtension": { -"description": "Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it is not cleared if the new name does not contain a valid extension.", +"description": "Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension.", "type": "string" }, "hasAugmentedPermissions": { @@ -3882,7 +3884,7 @@ "type": "boolean" }, "hasThumbnail": { -"description": "Output only. Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", +"description": "Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", "type": "boolean" }, "headRevisionId": { @@ -4063,7 +4065,7 @@ "type": "string" }, "mimeType": { -"description": "The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the About resource.", +"description": "The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.", "type": "string" }, "modifiedByMe": { @@ -4081,7 +4083,7 @@ "type": "string" }, "name": { -"description": "The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.", +"description": "The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.", "type": "string" }, "originalFilename": { @@ -4137,11 +4139,11 @@ "type": "string" }, "sha1Checksum": { -"description": "Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", +"description": "Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.", "type": "string" }, "sha256Checksum": { -"description": "Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", +"description": "Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.", "type": "string" }, "shared": { @@ -4169,19 +4171,19 @@ "type": "string" }, "targetResourceKey": { -"description": "Output only. The ResourceKey for the target file.", +"description": "Output only. The `resourceKey` for the target file.", "type": "string" } }, "type": "object" }, "size": { -"description": "Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.", +"description": "Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.", "format": "int64", "type": "string" }, "spaces": { -"description": "Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", +"description": "Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.", "items": { "type": "string" }, @@ -4197,7 +4199,7 @@ "type": "string" }, "thumbnailLink": { -"description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request.", +"description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.", "type": "string" }, "thumbnailVersion": { @@ -4278,14 +4280,14 @@ "id": "FileList", "properties": { "files": { -"description": "The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", +"description": "The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "File" }, "type": "array" }, "incompleteSearch": { -"description": "Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the 'allDrives' corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as 'user' or 'drive'.", +"description": "Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`.", "type": "boolean" }, "kind": { @@ -4414,7 +4416,7 @@ "type": "string" }, "kind": { -"description": "This is always drive#labelFieldModification.", +"description": "This is always `\"drive#labelFieldModification\"`.", "type": "string" }, "setDateValues": { @@ -4448,7 +4450,7 @@ "type": "array" }, "setUserValues": { -"description": "Replaces a `user` field with these new values. The values must be valid email addresses.", +"description": "Replaces a `user` field with these new values. The values must be a valid email addresses.", "items": { "type": "string" }, @@ -4466,7 +4468,7 @@ "id": "LabelList", "properties": { "kind": { -"description": "This is always drive#labelList", +"description": "This is always `\"drive#labelList\"`.", "type": "string" }, "labels": { @@ -4484,7 +4486,7 @@ "type": "object" }, "LabelModification": { -"description": "A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.", +"description": "A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.", "id": "LabelModification", "properties": { "fieldModifications": { @@ -4495,7 +4497,7 @@ "type": "array" }, "kind": { -"description": "This is always drive#labelModification.", +"description": "This is always `\"drive#labelModification\"`.", "type": "string" }, "labelId": { @@ -4537,7 +4539,7 @@ "id": "ModifyLabelsRequest", "properties": { "kind": { -"description": "This is always drive#modifyLabelsRequest.", +"description": "This is always `\"drive#modifyLabelsRequest\"`.", "type": "string" }, "labelModifications": { @@ -4551,11 +4553,11 @@ "type": "object" }, "ModifyLabelsResponse": { -"description": "Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.", +"description": "Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request.", "id": "ModifyLabelsResponse", "properties": { "kind": { -"description": "This is always drive#modifyLabelsResponse", +"description": "This is always `\"drive#modifyLabelsResponse\"`.", "type": "string" }, "modifiedLabels": { From 013fd0bb23681b5ca655ec1cbe2f27d3051310ee Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 11/27] feat(file): update the api #### file:v1 The following keys were added: - schemas.NetworkConfig.properties.pscConfig.$ref (Total Keys: 1) - schemas.NfsExportOptions.properties.network.type (Total Keys: 1) - schemas.PscConfig (Total Keys: 3) --- .../file_v1.projects.locations.instances.html | 16 +++++++++++ .../discovery_cache/documents/file.v1.json | 27 ++++++++++++++++--- 2 files changed, 40 insertions(+), 3 deletions(-) diff --git a/docs/dyn/file_v1.projects.locations.instances.html b/docs/dyn/file_v1.projects.locations.instances.html index 94425d01e94..cd0dd3e7b82 100644 --- a/docs/dyn/file_v1.projects.locations.instances.html +++ b/docs/dyn/file_v1.projects.locations.instances.html @@ -144,6 +144,7 @@

Method Details

"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions. "A String", ], + "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field. "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], @@ -167,6 +168,9 @@

Method Details

"A String", ], "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. + "pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. + "endpointProject": "A String", # Optional. Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. + }, "reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], @@ -313,6 +317,7 @@

Method Details

"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions. "A String", ], + "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field. "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], @@ -336,6 +341,9 @@

Method Details

"A String", ], "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. + "pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. + "endpointProject": "A String", # Optional. Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. + }, "reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], @@ -423,6 +431,7 @@

Method Details

"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions. "A String", ], + "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field. "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], @@ -446,6 +455,9 @@

Method Details

"A String", ], "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. + "pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. + "endpointProject": "A String", # Optional. Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. + }, "reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], @@ -542,6 +554,7 @@

Method Details

"ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions. "A String", ], + "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field. "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], @@ -565,6 +578,9 @@

Method Details

"A String", ], "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. + "pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. + "endpointProject": "A String", # Optional. Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. + }, "reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json index 7ec234fa02f..2894e9db058 100644 --- a/googleapiclient/discovery_cache/documents/file.v1.json +++ b/googleapiclient/discovery_cache/documents/file.v1.json @@ -908,7 +908,7 @@ } } }, -"revision": "20250819", +"revision": "20250825", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1874,12 +1874,14 @@ "enum": [ "CONNECT_MODE_UNSPECIFIED", "DIRECT_PEERING", -"PRIVATE_SERVICE_ACCESS" +"PRIVATE_SERVICE_ACCESS", +"PRIVATE_SERVICE_CONNECT" ], "enumDescriptions": [ "Not set.", "Connect via direct peering to the Filestore service.", -"Connect to your Filestore instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Filestore." +"Connect to your Filestore instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Filestore.", +"Connect to your Filestore instance using Private Service Connect. A connection policy must exist in the region for the VPC network and the google-cloud-filestore service class." ], "type": "string" }, @@ -1910,6 +1912,10 @@ "description": "The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.", "type": "string" }, +"pscConfig": { +"$ref": "PscConfig", +"description": "Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT." +}, "reservedIpRange": { "description": "Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.", "type": "string" @@ -1952,6 +1958,10 @@ }, "type": "array" }, +"network": { +"description": "Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.", +"type": "string" +}, "squashMode": { "description": "Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.", "enum": [ @@ -2111,6 +2121,17 @@ }, "type": "object" }, +"PscConfig": { +"description": "Private Service Connect configuration.", +"id": "PscConfig", +"properties": { +"endpointProject": { +"description": "Optional. Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project.", +"type": "string" +} +}, +"type": "object" +}, "ReplicaConfig": { "description": "Replica configuration for the instance.", "id": "ReplicaConfig", From da6b0fc6cda83448a47474b47f66576a42da7e1f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:09 +0000 Subject: [PATCH 12/27] feat(firebaseappcheck): update the api #### firebaseappcheck:v1 The following keys were added: - schemas.GoogleFirebaseAppcheckV1PlayIntegrityConfig.properties.accountDetails.$ref (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1PlayIntegrityConfig.properties.appIntegrity.$ref (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1PlayIntegrityConfig.properties.deviceIntegrity.$ref (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails (Total Keys: 3) - schemas.GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity (Total Keys: 3) - schemas.GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity (Total Keys: 3) - schemas.GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig.properties.riskAnalysis.$ref (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis (Total Keys: 4) - schemas.GoogleFirebaseAppcheckV1RecaptchaV3Config.properties.minValidScore (Total Keys: 2) #### firebaseappcheck:v1beta The following keys were added: - schemas.GoogleFirebaseAppcheckV1betaPlayIntegrityConfig.properties.accountDetails.$ref (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1betaPlayIntegrityConfig.properties.appIntegrity.$ref (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1betaPlayIntegrityConfig.properties.deviceIntegrity.$ref (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails (Total Keys: 3) - schemas.GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity (Total Keys: 3) - schemas.GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity (Total Keys: 3) - schemas.GoogleFirebaseAppcheckV1betaRecaptchaConfig.properties.minValidScore (Total Keys: 2) - schemas.GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig.properties.riskAnalysis.$ref (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis (Total Keys: 4) - schemas.GoogleFirebaseAppcheckV1betaRecaptchaV3Config.properties.minValidScore (Total Keys: 2) --- ..._v1.projects.apps.playIntegrityConfig.html | 36 ++++++++ ...ojects.apps.recaptchaEnterpriseConfig.html | 12 +++ ...ck_v1.projects.apps.recaptchaV3Config.html | 4 + ...eta.projects.apps.playIntegrityConfig.html | 36 ++++++++ ..._v1beta.projects.apps.recaptchaConfig.html | 4 + ...ojects.apps.recaptchaEnterpriseConfig.html | 12 +++ ...1beta.projects.apps.recaptchaV3Config.html | 4 + .../documents/firebaseappcheck.v1.json | 82 ++++++++++++++++- .../documents/firebaseappcheck.v1beta.json | 87 ++++++++++++++++++- 9 files changed, 275 insertions(+), 2 deletions(-) diff --git a/docs/dyn/firebaseappcheck_v1.projects.apps.playIntegrityConfig.html b/docs/dyn/firebaseappcheck_v1.projects.apps.playIntegrityConfig.html index 2a18e81e184..2380928262f 100644 --- a/docs/dyn/firebaseappcheck_v1.projects.apps.playIntegrityConfig.html +++ b/docs/dyn/firebaseappcheck_v1.projects.apps.playIntegrityConfig.html @@ -105,6 +105,15 @@

Method Details

{ # Response message for the BatchGetPlayIntegrityConfigs method. "configs": [ # PlayIntegrityConfigs retrieved. { # An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). + "accountDetails": { # A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "requireLicensed": True or False, # Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + }, + "appIntegrity": { # A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "allowUnrecognizedVersion": True or False, # Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + }, + "deviceIntegrity": { # A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. # Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + "minDeviceRecognitionLevel": "A String", # Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + }, "name": "A String", # Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from Play Integrity tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }, @@ -132,6 +141,15 @@

Method Details

An object of the form: { # An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). + "accountDetails": { # A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "requireLicensed": True or False, # Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + }, + "appIntegrity": { # A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "allowUnrecognizedVersion": True or False, # Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + }, + "deviceIntegrity": { # A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. # Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + "minDeviceRecognitionLevel": "A String", # Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + }, "name": "A String", # Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from Play Integrity tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }
@@ -147,6 +165,15 @@

Method Details

The object takes the form of: { # An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). + "accountDetails": { # A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "requireLicensed": True or False, # Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + }, + "appIntegrity": { # A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "allowUnrecognizedVersion": True or False, # Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + }, + "deviceIntegrity": { # A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. # Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + "minDeviceRecognitionLevel": "A String", # Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + }, "name": "A String", # Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from Play Integrity tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. } @@ -161,6 +188,15 @@

Method Details

An object of the form: { # An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). + "accountDetails": { # A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "requireLicensed": True or False, # Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + }, + "appIntegrity": { # A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "allowUnrecognizedVersion": True or False, # Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + }, + "deviceIntegrity": { # A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. # Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + "minDeviceRecognitionLevel": "A String", # Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + }, "name": "A String", # Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from Play Integrity tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }
diff --git a/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaEnterpriseConfig.html b/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaEnterpriseConfig.html index 2c914b3ba8f..4dd4d8315a8 100644 --- a/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaEnterpriseConfig.html +++ b/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaEnterpriseConfig.html @@ -106,6 +106,9 @@

Method Details

"configs": [ # RecaptchaEnterpriseConfigs retrieved. { # An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. "name": "A String", # Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` + "riskAnalysis": { # A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. # Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + }, "siteKey": "A String", # The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }, @@ -134,6 +137,9 @@

Method Details

{ # An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. "name": "A String", # Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` + "riskAnalysis": { # A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. # Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + }, "siteKey": "A String", # The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }
@@ -150,6 +156,9 @@

Method Details

{ # An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. "name": "A String", # Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` + "riskAnalysis": { # A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. # Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + }, "siteKey": "A String", # The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. } @@ -165,6 +174,9 @@

Method Details

{ # An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. "name": "A String", # Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` + "riskAnalysis": { # A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. # Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + }, "siteKey": "A String", # The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }
diff --git a/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaV3Config.html b/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaV3Config.html index b6067ef7769..49c2bca27c4 100644 --- a/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaV3Config.html +++ b/docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaV3Config.html @@ -105,6 +105,7 @@

Method Details

{ # Response message for the BatchGetRecaptchaV3Configs method. "configs": [ # RecaptchaV3Configs retrieved. { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. @@ -134,6 +135,7 @@

Method Details

An object of the form: { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. @@ -151,6 +153,7 @@

Method Details

The object takes the form of: { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. @@ -167,6 +170,7 @@

Method Details

An object of the form: { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.playIntegrityConfig.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.playIntegrityConfig.html index 1c85851bc72..71205cf4216 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.playIntegrityConfig.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.playIntegrityConfig.html @@ -105,6 +105,15 @@

Method Details

{ # Response message for the BatchGetPlayIntegrityConfigs method. "configs": [ # PlayIntegrityConfigs retrieved. { # An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). + "accountDetails": { # A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "requireLicensed": True or False, # Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + }, + "appIntegrity": { # A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "allowUnrecognizedVersion": True or False, # Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + }, + "deviceIntegrity": { # A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. # Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + "minDeviceRecognitionLevel": "A String", # Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + }, "name": "A String", # Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from Play Integrity tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }, @@ -132,6 +141,15 @@

Method Details

An object of the form: { # An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). + "accountDetails": { # A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "requireLicensed": True or False, # Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + }, + "appIntegrity": { # A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "allowUnrecognizedVersion": True or False, # Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + }, + "deviceIntegrity": { # A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. # Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + "minDeviceRecognitionLevel": "A String", # Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + }, "name": "A String", # Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from Play Integrity tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }
@@ -147,6 +165,15 @@

Method Details

The object takes the form of: { # An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). + "accountDetails": { # A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "requireLicensed": True or False, # Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + }, + "appIntegrity": { # A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "allowUnrecognizedVersion": True or False, # Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + }, + "deviceIntegrity": { # A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. # Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + "minDeviceRecognitionLevel": "A String", # Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + }, "name": "A String", # Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from Play Integrity tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. } @@ -161,6 +188,15 @@

Method Details

An object of the form: { # An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create). + "accountDetails": { # A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "requireLicensed": True or False, # Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`. + }, + "appIntegrity": { # A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. # Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended. + "allowUnrecognizedVersion": True or False, # Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`. + }, + "deviceIntegrity": { # A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. # Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended. + "minDeviceRecognitionLevel": "A String", # Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`. + }, "name": "A String", # Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from Play Integrity tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }
diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html index baada6efb57..caa2aec3e15 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html @@ -105,6 +105,7 @@

Method Details

{ # Response message for the BatchGetRecaptchaConfigs method. "configs": [ # RecaptchaConfigs retrieved. { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. @@ -134,6 +135,7 @@

Method Details

An object of the form: { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. @@ -151,6 +153,7 @@

Method Details

The object takes the form of: { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. @@ -167,6 +170,7 @@

Method Details

An object of the form: { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaEnterpriseConfig.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaEnterpriseConfig.html index db1e5c4785b..1ea96552825 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaEnterpriseConfig.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaEnterpriseConfig.html @@ -106,6 +106,9 @@

Method Details

"configs": [ # RecaptchaEnterpriseConfigs retrieved. { # An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. "name": "A String", # Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` + "riskAnalysis": { # A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. # Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + }, "siteKey": "A String", # The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }, @@ -134,6 +137,9 @@

Method Details

{ # An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. "name": "A String", # Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` + "riskAnalysis": { # A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. # Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + }, "siteKey": "A String", # The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }
@@ -150,6 +156,9 @@

Method Details

{ # An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. "name": "A String", # Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` + "riskAnalysis": { # A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. # Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + }, "siteKey": "A String", # The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. } @@ -165,6 +174,9 @@

Method Details

{ # An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. "name": "A String", # Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` + "riskAnalysis": { # A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. # Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. + }, "siteKey": "A String", # The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }
diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaV3Config.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaV3Config.html index 291469578fa..a440c31ab5e 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaV3Config.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaV3Config.html @@ -105,6 +105,7 @@

Method Details

{ # Response message for the BatchGetRecaptchaV3Configs method. "configs": [ # RecaptchaV3Configs retrieved. { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. @@ -134,6 +135,7 @@

Method Details

An object of the form: { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. @@ -151,6 +153,7 @@

Method Details

The object takes the form of: { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. @@ -167,6 +170,7 @@

Method Details

An object of the form: { # An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl. + "minValidScore": 3.14, # Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5. "name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json index a11345df90b..b8deba59e7f 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json @@ -1661,7 +1661,7 @@ } } }, -"revision": "20240930", +"revision": "20250901", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { @@ -2174,6 +2174,18 @@ "description": "An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).", "id": "GoogleFirebaseAppcheckV1PlayIntegrityConfig", "properties": { +"accountDetails": { +"$ref": "GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails", +"description": "Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended." +}, +"appIntegrity": { +"$ref": "GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity", +"description": "Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended." +}, +"deviceIntegrity": { +"$ref": "GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity", +"description": "Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended." +}, "name": { "description": "Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ```", "type": "string" @@ -2186,6 +2198,53 @@ }, "type": "object" }, +"GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails": { +"description": "A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended.", +"id": "GoogleFirebaseAppcheckV1PlayIntegrityConfigAccountDetails", +"properties": { +"requireLicensed": { +"description": "Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity": { +"description": "A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended.", +"id": "GoogleFirebaseAppcheckV1PlayIntegrityConfigAppIntegrity", +"properties": { +"allowUnrecognizedVersion": { +"description": "Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity": { +"description": "A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended.", +"id": "GoogleFirebaseAppcheckV1PlayIntegrityConfigDeviceIntegrity", +"properties": { +"minDeviceRecognitionLevel": { +"description": "Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`.", +"enum": [ +"DEVICE_RECOGNITION_LEVEL_UNSPECIFIED", +"NO_INTEGRITY", +"MEETS_BASIC_INTEGRITY", +"MEETS_DEVICE_INTEGRITY", +"MEETS_STRONG_INTEGRITY" +], +"enumDescriptions": [ +"Default value. Do not specify this value directly. When this default value is detected in a configuration, the `NO_INTEGRITY` default level takes effect.", +"If this level is set, no explicit device integrity label requirements will be checked. However, because Play Integrity's other features may perform (and require) their own intrinsic device integrity checks, your `app_integrity` and `account_details` settings may still cause some device integrity checks to be performed.", +"This level corresponds to the `MEETS_BASIC_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the most basic level of device integrity, and is the minimum allowed in App Check's standard implementation of Play Integrity. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_BASIC_INTEGRITY` but not `MEETS_DEVICE_INTEGRITY`. This API is **not** responsible for any such opt-ins.", +"This level corresponds to the `MEETS_DEVICE_INTEGRITY` [device recognition verdict](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field). Any app integrated with Play Integrity will automatically be eligible to receive this label without any additional action from you. At this level, devices that have the `MEETS_BASIC_INTEGRITY` label but **not** the `MEETS_DEVICE_INTEGRITY` label will be rejected.", +"This level corresponds to the `MEETS_STRONG_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the highest level of device integrity. At this level, devices that have the `MEETS_BASIC_INTEGRITY` or `MEETS_DEVICE_INTEGRITY` but **not** the `MEETS_STRONG_INTEGRITY` label will be rejected. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_STRONG_INTEGRITY`. This API is **not** responsible for any such opt-ins." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleFirebaseAppcheckV1PublicJwk": { "description": "A JWK as specified by [section 4 of RFC 7517](https://tools.ietf.org/html/rfc7517#section-4) and [section 6.3.1 of RFC 7518](https://tools.ietf.org/html/rfc7518#section-6.3.1).", "id": "GoogleFirebaseAppcheckV1PublicJwk", @@ -2239,6 +2298,10 @@ "description": "Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ```", "type": "string" }, +"riskAnalysis": { +"$ref": "GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis", +"description": "Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended." +}, "siteKey": { "description": "The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.", "type": "string" @@ -2251,10 +2314,27 @@ }, "type": "object" }, +"GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis": { +"description": "A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended.", +"id": "GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfigRiskAnalysis", +"properties": { +"minValidScore": { +"description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleFirebaseAppcheckV1RecaptchaV3Config": { "description": "An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl.", "id": "GoogleFirebaseAppcheckV1RecaptchaV3Config", "properties": { +"minValidScore": { +"description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", +"format": "float", +"type": "number" +}, "name": { "description": "Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ```", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index 5af296d0c75..540dd9b8ba3 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -1823,7 +1823,7 @@ } } }, -"revision": "20240930", +"revision": "20250901", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { @@ -2390,6 +2390,18 @@ "description": "An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).", "id": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfig", "properties": { +"accountDetails": { +"$ref": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails", +"description": "Specifies account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended." +}, +"appIntegrity": { +"$ref": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity", +"description": "Specifies application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended." +}, +"deviceIntegrity": { +"$ref": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity", +"description": "Specifies device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended." +}, "name": { "description": "Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ```", "type": "string" @@ -2402,6 +2414,53 @@ }, "type": "object" }, +"GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails": { +"description": "A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the [**account details** field](https://developer.android.com/google/play/integrity/verdicts#account-details-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended.", +"id": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails", +"properties": { +"requireLicensed": { +"description": "Specifies whether the caller must have received the [`LICENSED` verdict](https://developer.android.com/google/play/integrity/verdicts#account-details-field). For additional details about scenarios where your users will receive this `LICENSED` label, see [the default responses table](https://developer.android.com/google/play/integrity/setup#default). If set to `true`, apps without the `LICENSED` app licensing verdict will be rejected. If set to `false`, any app licensing verdict is allowed. The default value is `false`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity": { +"description": "A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the [**application integrity** field](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. The default values for these settings work for most apps, and are recommended.", +"id": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity", +"properties": { +"allowUnrecognizedVersion": { +"description": "Specifies whether your running app is allowed to have the `UNRECOGNIZED_VERSION` [app recognition verdict](https://developer.android.com/google/play/integrity/verdicts#application-integrity-field). Note that the app recognition verdict `PLAY_RECOGNIZED` is a strong, comprehensive integrity signal that takes into account various other signals, including conditional and optional device integrity responses that you have opted into. If your app is published off-Play, this field should be set to `true` to allow instances of your app installed from off-Play sources to function. If set to `false`, only `PLAY_RECOGNIZED` verdicts are allowed, and both `UNRECOGNIZED_VERSION` and `UNEVALUATED` will be rejected. If set to `true`, any app recognition verdict is allowed. The default value is `false`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity": { +"description": "A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the [**device integrity** field](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field) obtained from the Play Integrity API. See the [default responses table](https://developer.android.com/google/play/integrity/setup#default) for a quick summary. Warning: There are also [conditional](https://developer.android.com/google/play/integrity/setup#conditional) as well as [optional](https://developer.android.com/google/play/integrity/setup#optional_device_information) responses that you can receive, but requires additional explicit opt-in from you. The App Check API is **not** responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended.", +"id": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity", +"properties": { +"minDeviceRecognitionLevel": { +"description": "Specifies the minimum device integrity level in order for the device to be considered valid. Any device with a device recognition verdict lower than this level will be rejected. If this is unspecified, the default level is `NO_INTEGRITY`.", +"enum": [ +"DEVICE_RECOGNITION_LEVEL_UNSPECIFIED", +"NO_INTEGRITY", +"MEETS_BASIC_INTEGRITY", +"MEETS_DEVICE_INTEGRITY", +"MEETS_STRONG_INTEGRITY" +], +"enumDescriptions": [ +"Default value. Do not specify this value directly. When this default value is detected in a configuration, the `NO_INTEGRITY` default level takes effect.", +"If this level is set, no explicit device integrity label requirements will be checked. However, because Play Integrity's other features may perform (and require) their own intrinsic device integrity checks, your `app_integrity` and `account_details` settings may still cause some device integrity checks to be performed.", +"This level corresponds to the `MEETS_BASIC_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the most basic level of device integrity, and is the minimum allowed in App Check's standard implementation of Play Integrity. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_BASIC_INTEGRITY` but not `MEETS_DEVICE_INTEGRITY`. This API is **not** responsible for any such opt-ins.", +"This level corresponds to the `MEETS_DEVICE_INTEGRITY` [device recognition verdict](https://developer.android.com/google/play/integrity/verdicts#device-integrity-field). Any app integrated with Play Integrity will automatically be eligible to receive this label without any additional action from you. At this level, devices that have the `MEETS_BASIC_INTEGRITY` label but **not** the `MEETS_DEVICE_INTEGRITY` label will be rejected.", +"This level corresponds to the `MEETS_STRONG_INTEGRITY` [optional device recognition label](https://developer.android.com/google/play/integrity/verdicts#optional-device-labels). This value represents the highest level of device integrity. At this level, devices that have the `MEETS_BASIC_INTEGRITY` or `MEETS_DEVICE_INTEGRITY` but **not** the `MEETS_STRONG_INTEGRITY` label will be rejected. Warning: Because this is an optional response, you **must** first explicitly [opt in your app in the Play Console](https://developer.android.com/google/play/integrity/setup#optional) in order to receive this label. Without this opt-in, **your app may break** for any user whose device is eligible for `MEETS_STRONG_INTEGRITY`. This API is **not** responsible for any such opt-ins." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleFirebaseAppcheckV1betaPublicJwk": { "description": "A JWK as specified by [section 4 of RFC 7517](https://tools.ietf.org/html/rfc7517#section-4) and [section 6.3.1 of RFC 7518](https://tools.ietf.org/html/rfc7518#section-6.3.1).", "id": "GoogleFirebaseAppcheckV1betaPublicJwk", @@ -2452,6 +2511,11 @@ "description": "An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl.", "id": "GoogleFirebaseAppcheckV1betaRecaptchaConfig", "properties": { +"minValidScore": { +"description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", +"format": "float", +"type": "number" +}, "name": { "description": "Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ```", "type": "string" @@ -2481,6 +2545,10 @@ "description": "Required. The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ```", "type": "string" }, +"riskAnalysis": { +"$ref": "GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis", +"description": "Specifies risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended." +}, "siteKey": { "description": "The score-based site key [created in reCAPTCHA Enterprise](https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key) used to [invoke reCAPTCHA and generate the reCAPTCHA tokens](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages) for your application. Important: This is *not* the `site_secret` (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.", "type": "string" @@ -2493,10 +2561,27 @@ }, "type": "object" }, +"GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis": { +"description": "A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the [**`riskAnalysis`**](https://cloud.google.com/recaptcha/docs/interpret-assessment-website#interpret_assessment) tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended.", +"id": "GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis", +"properties": { +"minValidScore": { +"description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleFirebaseAppcheckV1betaRecaptchaV3Config": { "description": "An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned `AppCheckToken`, such as its ttl.", "id": "GoogleFirebaseAppcheckV1betaRecaptchaV3Config", "properties": { +"minValidScore": { +"description": "Specifies a minimum score required for a reCAPTCHA token to be considered valid. If its score is greater than or equal to this value, it will be accepted; otherwise, it will be rejected. The value must be between 0.0 and 1.0. The default value is 0.5.", +"format": "float", +"type": "number" +}, "name": { "description": "Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ```", "type": "string" From e01005c385b869833d0a80a93bf0516445f81f08 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 13/27] feat(firebaseappdistribution): update the api #### firebaseappdistribution:v1alpha The following keys were added: - schemas.GoogleFirebaseAppdistroV1alphaDeviceExecution.properties.videoStartTime (Total Keys: 3) - schemas.GoogleFirebaseAppdistroV1alphaGoalAction.properties.startTime (Total Keys: 3) --- ..._v1alpha.projects.apps.releases.tests.html | 32 ++++++++++++------- .../firebaseappdistribution.v1alpha.json | 22 ++++++++++--- 2 files changed, 37 insertions(+), 17 deletions(-) diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index 84727ac047c..853c61953cb 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -154,9 +154,9 @@

Method Details

"goalDetails": { # Details for a goal step. # Output only. Details for a goal step. "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. { # An action taken by the AI agent while attempting to accomplish a goal. - "debugInfo": { # Information to help the customer understand why the agent took this action # Output only. Debug information explaining why the agent to the specific action - "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent - "jsonUri": "A String", # Output only. Structured data explaining the agent's choice + "debugInfo": { # Information to help the customer understand why the agent took this action. # Output only. Debug information explaining why the agent to the specific action. + "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent. + "jsonUri": "A String", # Output only. Structured data explaining the agent's choice. }, "deviceAction": { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device. "description": "A String", # Output only. A short description of the high level action taken by the AI agent. @@ -215,6 +215,7 @@

Method Details

], }, "explanation": "A String", # Output only. An explanation justifying why the action was taken. + "startTime": "A String", # Output only. The time at which the action started. "terminalAction": { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal. "reason": "A String", # Output only. The reason why this goal was ended. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action. @@ -260,6 +261,7 @@

Method Details

"A String", ], "state": "A String", # Output only. The state of the test. + "videoStartTime": "A String", # Output only. The time at which the video started recording. "videoUri": "A String", # Output only. A URI to a video of the test run. }, ], @@ -316,9 +318,9 @@

Method Details

"goalDetails": { # Details for a goal step. # Output only. Details for a goal step. "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. { # An action taken by the AI agent while attempting to accomplish a goal. - "debugInfo": { # Information to help the customer understand why the agent took this action # Output only. Debug information explaining why the agent to the specific action - "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent - "jsonUri": "A String", # Output only. Structured data explaining the agent's choice + "debugInfo": { # Information to help the customer understand why the agent took this action. # Output only. Debug information explaining why the agent to the specific action. + "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent. + "jsonUri": "A String", # Output only. Structured data explaining the agent's choice. }, "deviceAction": { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device. "description": "A String", # Output only. A short description of the high level action taken by the AI agent. @@ -377,6 +379,7 @@

Method Details

], }, "explanation": "A String", # Output only. An explanation justifying why the action was taken. + "startTime": "A String", # Output only. The time at which the action started. "terminalAction": { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal. "reason": "A String", # Output only. The reason why this goal was ended. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action. @@ -422,6 +425,7 @@

Method Details

"A String", ], "state": "A String", # Output only. The state of the test. + "videoStartTime": "A String", # Output only. The time at which the video started recording. "videoUri": "A String", # Output only. A URI to a video of the test run. }, ], @@ -484,9 +488,9 @@

Method Details

"goalDetails": { # Details for a goal step. # Output only. Details for a goal step. "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. { # An action taken by the AI agent while attempting to accomplish a goal. - "debugInfo": { # Information to help the customer understand why the agent took this action # Output only. Debug information explaining why the agent to the specific action - "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent - "jsonUri": "A String", # Output only. Structured data explaining the agent's choice + "debugInfo": { # Information to help the customer understand why the agent took this action. # Output only. Debug information explaining why the agent to the specific action. + "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent. + "jsonUri": "A String", # Output only. Structured data explaining the agent's choice. }, "deviceAction": { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device. "description": "A String", # Output only. A short description of the high level action taken by the AI agent. @@ -545,6 +549,7 @@

Method Details

], }, "explanation": "A String", # Output only. An explanation justifying why the action was taken. + "startTime": "A String", # Output only. The time at which the action started. "terminalAction": { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal. "reason": "A String", # Output only. The reason why this goal was ended. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action. @@ -590,6 +595,7 @@

Method Details

"A String", ], "state": "A String", # Output only. The state of the test. + "videoStartTime": "A String", # Output only. The time at which the video started recording. "videoUri": "A String", # Output only. A URI to a video of the test run. }, ], @@ -662,9 +668,9 @@

Method Details

"goalDetails": { # Details for a goal step. # Output only. Details for a goal step. "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. { # An action taken by the AI agent while attempting to accomplish a goal. - "debugInfo": { # Information to help the customer understand why the agent took this action # Output only. Debug information explaining why the agent to the specific action - "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent - "jsonUri": "A String", # Output only. Structured data explaining the agent's choice + "debugInfo": { # Information to help the customer understand why the agent took this action. # Output only. Debug information explaining why the agent to the specific action. + "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent. + "jsonUri": "A String", # Output only. Structured data explaining the agent's choice. }, "deviceAction": { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device. "description": "A String", # Output only. A short description of the high level action taken by the AI agent. @@ -723,6 +729,7 @@

Method Details

], }, "explanation": "A String", # Output only. An explanation justifying why the action was taken. + "startTime": "A String", # Output only. The time at which the action started. "terminalAction": { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal. "reason": "A String", # Output only. The reason why this goal was ended. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action. @@ -768,6 +775,7 @@

Method Details

"A String", ], "state": "A String", # Output only. The state of the test. + "videoStartTime": "A String", # Output only. The time at which the video started recording. "videoUri": "A String", # Output only. A URI to a video of the test run. }, ], diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 1a2aeacf58b..6a127e94351 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -807,7 +807,7 @@ } } }, -"revision": "20250825", +"revision": "20250902", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1316,6 +1316,12 @@ "readOnly": true, "type": "string" }, +"videoStartTime": { +"description": "Output only. The time at which the video started recording.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "videoUri": { "description": "Output only. A URI to a video of the test run.", "readOnly": true, @@ -1606,7 +1612,7 @@ "properties": { "debugInfo": { "$ref": "GoogleFirebaseAppdistroV1alphaGoalActionDebugInfo", -"description": "Output only. Debug information explaining why the agent to the specific action", +"description": "Output only. Debug information explaining why the agent to the specific action.", "readOnly": true }, "deviceAction": { @@ -1619,6 +1625,12 @@ "readOnly": true, "type": "string" }, +"startTime": { +"description": "Output only. The time at which the action started.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "terminalAction": { "$ref": "GoogleFirebaseAppdistroV1alphaTerminalAction", "description": "Output only. An action taken by the AI to end the goal.", @@ -1628,16 +1640,16 @@ "type": "object" }, "GoogleFirebaseAppdistroV1alphaGoalActionDebugInfo": { -"description": "Information to help the customer understand why the agent took this action", +"description": "Information to help the customer understand why the agent took this action.", "id": "GoogleFirebaseAppdistroV1alphaGoalActionDebugInfo", "properties": { "annotatedScreenshotUri": { -"description": "Output only. URI of the screenshot with elements labeled which was used by the agent", +"description": "Output only. URI of the screenshot with elements labeled which was used by the agent.", "readOnly": true, "type": "string" }, "jsonUri": { -"description": "Output only. Structured data explaining the agent's choice", +"description": "Output only. Structured data explaining the agent's choice.", "readOnly": true, "type": "string" } From 81bf81b4fa39a94834f4f463cdfe8cce9757a06e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 14/27] feat(firebaseml): update the api #### firebaseml:v2beta The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources.properties.flagContentUri.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.authorAttribution.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.flagContentUri.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.review.type (Total Keys: 1) The following keys were added: - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.modelConfig.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GoogleMaps.properties.enableWidget.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.reviewId.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.sourceFlaggingUris (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1Tool.properties.googleSearchRetrieval.deprecated (Total Keys: 1) --- ....projects.locations.publishers.models.html | 103 ++++++++--------- .../documents/firebaseml.v2beta.json | 107 +++++++++--------- 2 files changed, 105 insertions(+), 105 deletions(-) diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 74928100989..2318a48372e 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -383,13 +383,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -828,13 +829,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1019,25 +1021,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1085,6 +1080,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1149,38 +1150,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, }
@@ -1502,13 +1503,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1693,25 +1695,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1759,6 +1754,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1823,38 +1824,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, }
diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index b5cd97152df..8b6ca503182 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20250827", +"revision": "20250903", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1075,11 +1075,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata": { -"description": "Usage metadata about response(s).", +"description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "properties": { "cacheTokensDetails": { -"description": "Output only. List of modalities of the cached content in the request input.", +"description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -1087,18 +1087,18 @@ "type": "array" }, "cachedContentTokenCount": { -"description": "Output only. Number of tokens in the cached part in the input (the cached content).", +"description": "Output only. The number of tokens in the cached content that was used for this request.", "format": "int32", "readOnly": true, "type": "integer" }, "candidatesTokenCount": { -"description": "Number of tokens in the response(s).", +"description": "The total number of tokens in the generated candidates.", "format": "int32", "type": "integer" }, "candidatesTokensDetails": { -"description": "Output only. List of modalities that were returned in the response.", +"description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -1106,12 +1106,12 @@ "type": "array" }, "promptTokenCount": { -"description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", +"description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, "promptTokensDetails": { -"description": "Output only. List of modalities that were processed in the request input.", +"description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -1119,19 +1119,19 @@ "type": "array" }, "thoughtsTokenCount": { -"description": "Output only. Number of tokens present in thoughts output.", +"description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokenCount": { -"description": "Output only. Number of tokens present in tool-use prompt(s).", +"description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokensDetails": { -"description": "Output only. List of modalities that were processed for tool-use request inputs.", +"description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -1139,12 +1139,12 @@ "type": "array" }, "totalTokenCount": { -"description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", +"description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.", "format": "int32", "type": "integer" }, "trafficType": { -"description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.", +"description": "Output only. The traffic type for this request.", "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "ON_DEMAND", @@ -1152,7 +1152,7 @@ ], "enumDescriptions": [ "Unspecified request traffic type.", -"Type for Pay-As-You-Go traffic.", +"The request was processed using Pay-As-You-Go quota.", "Type for Provisioned Throughput traffic." ], "readOnly": true, @@ -1211,6 +1211,7 @@ }, "modelConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", +"deprecated": true, "description": "Optional. Config for model selection." }, "presencePenalty": { @@ -1386,7 +1387,12 @@ "GoogleCloudAiplatformV1beta1GoogleMaps": { "description": "Tool to retrieve public maps data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleMaps", -"properties": {}, +"properties": { +"enableWidget": { +"description": "Optional. If true, include the widget context token in the response.", +"type": "boolean" +} +}, "type": "object" }, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { @@ -1432,15 +1438,15 @@ "type": "string" }, "text": { -"description": "Text of the chunk.", +"description": "Text of the place answer.", "type": "string" }, "title": { -"description": "Title of the chunk.", +"description": "Title of the place.", "type": "string" }, "uri": { -"description": "URI reference of the chunk.", +"description": "URI reference of the place.", "type": "string" } }, @@ -1450,10 +1456,6 @@ "description": "Sources used to generate the place answer.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", "properties": { -"flagContentUri": { -"description": "A link where users can flag a problem with the generated answer.", -"type": "string" -}, "reviewSnippets": { "description": "Snippets of reviews that are used to generate the answer.", "items": { @@ -1464,47 +1466,20 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": { -"description": "Author attribution for a photo or review.", -"id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", -"properties": { -"displayName": { -"description": "Name of the author of the Photo or Review.", -"type": "string" -}, -"photoUri": { -"description": "Profile photo URI of the author of the Photo or Review.", -"type": "string" -}, -"uri": { -"description": "URI of the author of the Photo or Review.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { "description": "Encapsulates a review snippet.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { -"authorAttribution": { -"$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", -"description": "This review's author." -}, -"flagContentUri": { -"description": "A link where users can flag a problem with the review.", -"type": "string" -}, "googleMapsUri": { "description": "A link to show the review on Google Maps.", "type": "string" }, -"relativePublishTimeDescription": { -"description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.", +"reviewId": { +"description": "Id of the review referencing the place.", "type": "string" }, -"review": { -"description": "A reference representing this place review which may be used to look up this place review again.", +"title": { +"description": "Title of the review.", "type": "string" } }, @@ -1596,6 +1571,14 @@ "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint", "description": "Optional. Google search entry for the following-up web searches." }, +"sourceFlaggingUris": { +"description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri" +}, +"readOnly": true, +"type": "array" +}, "webSearchQueries": { "description": "Optional. Web search queries for the following-up web search.", "items": { @@ -1606,6 +1589,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": { +"description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", +"id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri", +"properties": { +"flagContentUri": { +"description": "A link where users can flag a problem with the source (place or review).", +"type": "string" +}, +"sourceId": { +"description": "Id of the place or review.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GroundingSupport": { "description": "Grounding support.", "id": "GoogleCloudAiplatformV1beta1GroundingSupport", @@ -2420,7 +2418,8 @@ false }, "googleSearchRetrieval": { "$ref": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", -"description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search." +"deprecated": true, +"description": "Optional. Specialized retrieval tool that is powered by Google Search." }, "retrieval": { "$ref": "GoogleCloudAiplatformV1beta1Retrieval", From 420db61e290051398ed0dea5350a36328af0f42f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 15/27] feat(gkeonprem): update the api #### gkeonprem:v1 The following keys were added: - schemas.VmwareAdminCluster.properties.proxy.$ref (Total Keys: 1) - schemas.VmwareAdminProxy (Total Keys: 3) --- ...rojects.locations.vmwareAdminClusters.html | 16 ++++++++++++++ .../documents/gkeonprem.v1.json | 21 ++++++++++++++++++- 2 files changed, 36 insertions(+), 1 deletion(-) diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html index 8980d1ab4e4..5234dbdea6e 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html @@ -316,6 +316,10 @@

Method Details

"address": "A String", # The registry address. "caCert": "A String", # When the container runtime pulls an image from private registry, the registry must prove its identity by presenting a certificate. The registry's certificate is signed by a certificate authority (CA). The container runtime uses the CA's certificate to validate the registry's certificate. }, + "proxy": { # VmwareAdminProxy represents configuration for admin cluster proxy. # Configuration for proxy. + "noProxy": "A String", # A comma-separated list of IP addresses, IP address ranges, host names, and domain names that should not go through the proxy server. When Google Distributed Cloud sends a request to one of these addresses, hosts, or domains, the request is sent directly. + "url": "A String", # The HTTP address of proxy server. + }, "reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware admin cluster. "state": "A String", # Output only. The current state of VMware admin cluster. "status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state. @@ -653,6 +657,10 @@

Method Details

"address": "A String", # The registry address. "caCert": "A String", # When the container runtime pulls an image from private registry, the registry must prove its identity by presenting a certificate. The registry's certificate is signed by a certificate authority (CA). The container runtime uses the CA's certificate to validate the registry's certificate. }, + "proxy": { # VmwareAdminProxy represents configuration for admin cluster proxy. # Configuration for proxy. + "noProxy": "A String", # A comma-separated list of IP addresses, IP address ranges, host names, and domain names that should not go through the proxy server. When Google Distributed Cloud sends a request to one of these addresses, hosts, or domains, the request is sent directly. + "url": "A String", # The HTTP address of proxy server. + }, "reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware admin cluster. "state": "A String", # Output only. The current state of VMware admin cluster. "status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state. @@ -959,6 +967,10 @@

Method Details

"address": "A String", # The registry address. "caCert": "A String", # When the container runtime pulls an image from private registry, the registry must prove its identity by presenting a certificate. The registry's certificate is signed by a certificate authority (CA). The container runtime uses the CA's certificate to validate the registry's certificate. }, + "proxy": { # VmwareAdminProxy represents configuration for admin cluster proxy. # Configuration for proxy. + "noProxy": "A String", # A comma-separated list of IP addresses, IP address ranges, host names, and domain names that should not go through the proxy server. When Google Distributed Cloud sends a request to one of these addresses, hosts, or domains, the request is sent directly. + "url": "A String", # The HTTP address of proxy server. + }, "reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware admin cluster. "state": "A String", # Output only. The current state of VMware admin cluster. "status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state. @@ -1227,6 +1239,10 @@

Method Details

"address": "A String", # The registry address. "caCert": "A String", # When the container runtime pulls an image from private registry, the registry must prove its identity by presenting a certificate. The registry's certificate is signed by a certificate authority (CA). The container runtime uses the CA's certificate to validate the registry's certificate. }, + "proxy": { # VmwareAdminProxy represents configuration for admin cluster proxy. # Configuration for proxy. + "noProxy": "A String", # A comma-separated list of IP addresses, IP address ranges, host names, and domain names that should not go through the proxy server. When Google Distributed Cloud sends a request to one of these addresses, hosts, or domains, the request is sent directly. + "url": "A String", # The HTTP address of proxy server. + }, "reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware admin cluster. "state": "A String", # Output only. The current state of VMware admin cluster. "status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state. diff --git a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json index cbdf3c9db74..d12afda0ba6 100644 --- a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json +++ b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json @@ -3105,7 +3105,7 @@ } } }, -"revision": "20250813", +"revision": "20250827", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -5695,6 +5695,10 @@ "$ref": "VmwareAdminPrivateRegistryConfig", "description": "Configuration for registry." }, +"proxy": { +"$ref": "VmwareAdminProxy", +"description": "Configuration for proxy." +}, "reconciling": { "description": "Output only. If set, there are currently changes in flight to the VMware admin cluster.", "readOnly": true, @@ -5940,6 +5944,21 @@ }, "type": "object" }, +"VmwareAdminProxy": { +"description": "VmwareAdminProxy represents configuration for admin cluster proxy.", +"id": "VmwareAdminProxy", +"properties": { +"noProxy": { +"description": "A comma-separated list of IP addresses, IP address ranges, host names, and domain names that should not go through the proxy server. When Google Distributed Cloud sends a request to one of these addresses, hosts, or domains, the request is sent directly.", +"type": "string" +}, +"url": { +"description": "The HTTP address of proxy server.", +"type": "string" +} +}, +"type": "object" +}, "VmwareAdminSeesawConfig": { "description": "VmwareSeesawConfig represents configuration parameters for an already existing Seesaw load balancer. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update Seesaw configurations it can only bind a pre-existing configuration to a new user cluster. IMPORTANT: When attempting to create a user cluster with a pre-existing Seesaw load balancer you will need to follow some preparation steps before calling the 'CreateVmwareCluster' API method. First you will need to create the user cluster's namespace via kubectl. The namespace will need to use the following naming convention : -gke-onprem-mgmt or -gke-onprem-mgmt depending on whether you used the 'VmwareCluster.local_name' to disambiguate collisions; for more context see the documentation of 'VmwareCluster.local_name'. Once the namespace is created you will need to create a secret resource via kubectl. This secret will contain copies of your Seesaw credentials. The Secret must be called 'user-cluster-creds' and contain Seesaw's SSH and Cert credentials. The credentials must be keyed with the following names: 'seesaw-ssh-private-key', 'seesaw-ssh-public-key', 'seesaw-ssh-ca-key', 'seesaw-ssh-ca-cert'.", "id": "VmwareAdminSeesawConfig", From 4f92adbf7597e7463a8be582ed7fc5ccfcc4cad1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 16/27] feat(healthcare): update the api #### healthcare:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.updateInstances (Total Keys: 16) - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.updateInstances (Total Keys: 16) - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.updateMetadata (Total Keys: 16) - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.methods.updateMetadata (Total Keys: 16) - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.updateMetadata (Total Keys: 16) - schemas.UpdateSeriesMetadataResponse (Total Keys: 2) - schemas.UpdateStudyMetadataResponse (Total Keys: 2) --- ...ts.locations.datasets.fhirStores.fhir.html | 8 +- .../dyn/healthcare_v1.projects.locations.html | 2 +- ...ojects.locations.datasets.dicomStores.html | 42 ++++ ...ocations.datasets.dicomStores.studies.html | 94 ++++++++ ...s.datasets.dicomStores.studies.series.html | 52 +++++ ....dicomStores.studies.series.instances.html | 42 ++++ ...ts.locations.datasets.fhirStores.fhir.html | 8 +- ...rojects.locations.datasets.fhirStores.html | 12 +- ...healthcare_v1beta1.projects.locations.html | 2 +- .../documents/healthcare.v1.json | 8 +- .../documents/healthcare.v1beta1.json | 207 +++++++++++++++++- 11 files changed, 452 insertions(+), 25 deletions(-) diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html index a3c741e6c60..1f4805b29c9 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html @@ -139,10 +139,10 @@

Instance Methods

Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#read), [R5](https://hl7.org/fhir/R5/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread), [R5](https://hl7.org/fhir/R5/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).

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

-

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

+

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

search_type(parent, resourceType, body=None, x__xgafv=None)

-

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

+

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

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

Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The conditional update interaction If-None-Match is supported, including the wildcard behaviour, as defined by the R5 spec. This functionality is supported in R4 and R5. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).

@@ -768,7 +768,7 @@

Method Details

search(parent, body=None, x__xgafv=None) -
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
+  
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
 
 Args:
   parent: string, Required. Name of the FHIR store to retrieve resources from. (required)
@@ -800,7 +800,7 @@ 

Method Details

search_type(parent, resourceType, body=None, x__xgafv=None) -
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
+  
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
 
 Args:
   parent: string, Required. Name of the FHIR store to retrieve resources from. (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.html b/docs/dyn/healthcare_v1.projects.locations.html
index fbb99c62d7a..015d2b6f34e 100644
--- a/docs/dyn/healthcare_v1.projects.locations.html
+++ b/docs/dyn/healthcare_v1.projects.locations.html
@@ -135,7 +135,7 @@ 

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html index 25adb3d80b1..560f8b25347 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html @@ -141,6 +141,9 @@

Instance Methods

testIamPermissions(resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

+ updateInstances(parent, dicomWebPath, body=None, x__xgafv=None)

+

UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).

Method Details

close() @@ -1098,4 +1101,43 @@

Method Details

}
+
+ updateInstances(parent, dicomWebPath, body=None, x__xgafv=None) +
UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).
+
+Args:
+  parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
+  dicomWebPath: string, Required. The path of the UpdateInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html index 22f6f03b840..ff8946c73be 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html @@ -100,6 +100,12 @@

Instance Methods

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None)

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

+

+ updateInstances(parent, dicomWebPath, body=None, x__xgafv=None)

+

UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).

+

+ updateMetadata(parent, dicomWebPath, body=None, x__xgafv=None)

+

UpdateStudyMetadata modifies the metadata of all instances in the given study. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the study.

Method Details

close() @@ -285,4 +291,92 @@

Method Details

}
+
+ updateInstances(parent, dicomWebPath, body=None, x__xgafv=None) +
UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).
+
+Args:
+  parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
+  dicomWebPath: string, Required. The path of the UpdateInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ updateMetadata(parent, dicomWebPath, body=None, x__xgafv=None) +
UpdateStudyMetadata modifies the metadata of all instances in the given study. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the study.
+
+Args:
+  parent: string, Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
+  dicomWebPath: string, Required. The path of the UpdateStudyMetadata request (for example, `studies/{study_uid}`). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  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/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html index 814be8616b1..c760a72baf1 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.html @@ -94,6 +94,9 @@

Instance Methods

searchForInstances(parent, dicomWebPath, x__xgafv=None)

SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

+

+ updateMetadata(parent, dicomWebPath, body=None, x__xgafv=None)

+

UpdateSeriesMetadata modifies the metadata of all instances in the given series. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the series.

Method Details

close() @@ -214,4 +217,53 @@

Method Details

}
+
+ updateMetadata(parent, dicomWebPath, body=None, x__xgafv=None) +
UpdateSeriesMetadata modifies the metadata of all instances in the given series. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the series.
+
+Args:
+  parent: string, Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
+  dicomWebPath: string, Required. The path of the UpdateSeriesMetadata request (for example, `studies/{study_uid}/series/{series_uid}`). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  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/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.html index bb7d0f9dfab..5bd329f43e6 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.html @@ -99,6 +99,9 @@

Instance Methods

retrieveRendered(parent, dicomWebPath, viewport=None, x__xgafv=None)

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

+

+ updateMetadata(parent, dicomWebPath, body=None, x__xgafv=None)

+

UpdateInstanceMetadata modifies the metadata of a single instance. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of the instance.

Method Details

close() @@ -203,4 +206,43 @@

Method Details

}
+
+ updateMetadata(parent, dicomWebPath, body=None, x__xgafv=None) +
UpdateInstanceMetadata modifies the metadata of a single instance. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of the instance.
+
+Args:
+  parent: string, Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
+  dicomWebPath: string, Required. The path of the UpdateInstanceMetadata request (for example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html index 4786ad01547..f006bbbf06a 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html @@ -154,10 +154,10 @@

Instance Methods

Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#read)), [R5](https://hl7.org/fhir/R5/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread)), [R5](https://hl7.org/fhir/R5/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).

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

-

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

+

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

search_type(parent, resourceType, body=None, x__xgafv=None)

-

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

+

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

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

Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The conditional update interaction If-None-Match is supported, including the wildcard behaviour, as defined by the R5 spec. This functionality is supported in R4 and R5. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).

@@ -926,7 +926,7 @@

Method Details

search(parent, body=None, x__xgafv=None) -
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
+  
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
 
 Args:
   parent: string, Required. Name of the FHIR store to retrieve resources from. (required)
@@ -958,7 +958,7 @@ 

Method Details

search_type(parent, resourceType, body=None, x__xgafv=None) -
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
+  
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
 
 Args:
   parent: string, Required. Name of the FHIR store to retrieve resources from. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
index 4c95e43d4db..87292d7c742 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
@@ -358,7 +358,7 @@ 

Method Details

"defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", @@ -647,7 +647,7 @@

Method Details

"defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", @@ -1370,7 +1370,7 @@

Method Details

"defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", @@ -1835,7 +1835,7 @@

Method Details

"defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", @@ -2142,7 +2142,7 @@

Method Details

"defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", @@ -2431,7 +2431,7 @@

Method Details

"defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors. "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.html b/docs/dyn/healthcare_v1beta1.projects.locations.html index e905544c372..aabe493c337 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 537c2813d5b..1304963ffe0 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -4198,7 +4198,7 @@ ] }, "search": { -"description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", +"description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -4227,7 +4227,7 @@ ] }, "search-type": { -"description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", +"description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", @@ -5132,7 +5132,7 @@ } } }, -"revision": "20250724", +"revision": "20250821", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 491ca126b66..bcf8842dbfe 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2246,6 +2246,43 @@ "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updateInstances": { +"description": "UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", +"httpMethod": "PUT", +"id": "healthcare.projects.locations.datasets.dicomStores.updateInstances", +"parameterOrder": [ +"parent", +"dicomWebPath" +], +"parameters": { +"dicomWebPath": { +"description": "Required. The path of the UpdateInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.", +"location": "path", +"pattern": "^studies$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -2583,6 +2620,80 @@ "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updateInstances": { +"description": "UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", +"httpMethod": "PUT", +"id": "healthcare.projects.locations.datasets.dicomStores.studies.updateInstances", +"parameterOrder": [ +"parent", +"dicomWebPath" +], +"parameters": { +"dicomWebPath": { +"description": "Required. The path of the UpdateInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.", +"location": "path", +"pattern": "^studies/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"updateMetadata": { +"description": "UpdateStudyMetadata modifies the metadata of all instances in the given study. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the study.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", +"httpMethod": "PATCH", +"id": "healthcare.projects.locations.datasets.dicomStores.studies.updateMetadata", +"parameterOrder": [ +"parent", +"dicomWebPath" +], +"parameters": { +"dicomWebPath": { +"description": "Required. The path of the UpdateStudyMetadata request (for example, `studies/{study_uid}`).", +"location": "path", +"pattern": "^studies/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`).", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}/metadata", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -2723,6 +2834,43 @@ "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updateMetadata": { +"description": "UpdateSeriesMetadata modifies the metadata of all instances in the given series. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the series.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", +"httpMethod": "PATCH", +"id": "healthcare.projects.locations.datasets.dicomStores.studies.series.updateMetadata", +"parameterOrder": [ +"parent", +"dicomWebPath" +], +"parameters": { +"dicomWebPath": { +"description": "Required. The path of the UpdateSeriesMetadata request (for example, `studies/{study_uid}/series/{series_uid}`).", +"location": "path", +"pattern": "^studies/[^/]+/series/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`).", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}/metadata", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -2868,6 +3016,43 @@ "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updateMetadata": { +"description": "UpdateInstanceMetadata modifies the metadata of a single instance. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of the instance.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", +"httpMethod": "PATCH", +"id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.updateMetadata", +"parameterOrder": [ +"parent", +"dicomWebPath" +], +"parameters": { +"dicomWebPath": { +"description": "Required. The path of the UpdateInstanceMetadata request (for example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`).", +"location": "path", +"pattern": "^studies/[^/]+/series/[^/]+/instances/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`).", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}/metadata", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -4507,7 +4692,7 @@ ] }, "search": { -"description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", +"description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -4536,7 +4721,7 @@ ] }, "search-type": { -"description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", +"description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", @@ -5494,7 +5679,7 @@ } } }, -"revision": "20250724", +"revision": "20250821", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -7383,7 +7568,7 @@ "type": "boolean" }, "enableHistoryModifications": { -"description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false.", +"description": "Optional. Whether to allow the [ImportResourcesHistory] and [ExecuteBundle] APIs to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. Changing resource histories creates resource interactions that have occurred in the past which clients might not allow. If set to false, [ImportResourcesHistory] and [ExecuteBundle] requests will return errors.", "type": "boolean" }, "enableUpdateCreate": { @@ -9789,6 +9974,18 @@ }, "type": "object" }, +"UpdateSeriesMetadataResponse": { +"description": "UpdateSeriesMetadataResponse is the LRO response for UpdateSeriesMetadata.", +"id": "UpdateSeriesMetadataResponse", +"properties": {}, +"type": "object" +}, +"UpdateStudyMetadataResponse": { +"description": "UpdateStudyMetadataResponse is the LRO response for UpdateStudyMetadata.", +"id": "UpdateStudyMetadataResponse", +"properties": {}, +"type": "object" +}, "UserDataMapping": { "description": "Maps a resource to the associated user and Attributes.", "id": "UserDataMapping", From 7bb97eef03fb204dc55c7dd054d01dbb3662a664 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 17/27] fix(logging): update the api #### logging:v2 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/logging.v2.json | 152 +++++++++++++++++- 1 file changed, 151 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index 7fa695870a8..0250beff3a1 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -30,11 +30,126 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://logging.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-west15.rep.googleapis.com/", +"location": "europe-west15" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://logging.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, { "description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://logging.europe-west8.rep.googleapis.com/", "location": "europe-west8" }, @@ -45,11 +160,46 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://logging.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://logging.me-central2.rep.googleapis.com/", "location": "me-central2" }, { "description": "Regional Endpoint", +"endpointUrl": "https://logging.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://logging.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://logging.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -8962,7 +9112,7 @@ } } }, -"revision": "20250822", +"revision": "20250829", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { From 8a02a132170b01255592b8887f1eca90a37fbff2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 18/27] feat(managedkafka): update the api #### managedkafka:v1 The following keys were added: - schemas.Cluster.properties.updateOptions.$ref (Total Keys: 1) - schemas.UpdateOptions (Total Keys: 3) --- ...gedkafka_v1.projects.locations.clusters.html | 12 ++++++++++++ .../documents/managedkafka.v1.json | 17 ++++++++++++++++- 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/docs/dyn/managedkafka_v1.projects.locations.clusters.html b/docs/dyn/managedkafka_v1.projects.locations.clusters.html index 4d361a98c17..7f45536ab70 100644 --- a/docs/dyn/managedkafka_v1.projects.locations.clusters.html +++ b/docs/dyn/managedkafka_v1.projects.locations.clusters.html @@ -161,6 +161,9 @@

Method Details

], }, }, + "updateOptions": { # UpdateOptions specifies options that influence how a cluster update is applied. These options control the behavior of the update process, rather than defining the desired end-state of a cluster. # Optional. UpdateOptions represents options that control how updates to the cluster are applied. + "allowBrokerDownscaleOnClusterUpscale": True or False, # Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size. + }, "updateTime": "A String", # Output only. The time when the cluster was last updated. } @@ -281,6 +284,9 @@

Method Details

], }, }, + "updateOptions": { # UpdateOptions specifies options that influence how a cluster update is applied. These options control the behavior of the update process, rather than defining the desired end-state of a cluster. # Optional. UpdateOptions represents options that control how updates to the cluster are applied. + "allowBrokerDownscaleOnClusterUpscale": True or False, # Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size. + }, "updateTime": "A String", # Output only. The time when the cluster was last updated. }
@@ -341,6 +347,9 @@

Method Details

], }, }, + "updateOptions": { # UpdateOptions specifies options that influence how a cluster update is applied. These options control the behavior of the update process, rather than defining the desired end-state of a cluster. # Optional. UpdateOptions represents options that control how updates to the cluster are applied. + "allowBrokerDownscaleOnClusterUpscale": True or False, # Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size. + }, "updateTime": "A String", # Output only. The time when the cluster was last updated. }, ], @@ -410,6 +419,9 @@

Method Details

], }, }, + "updateOptions": { # UpdateOptions specifies options that influence how a cluster update is applied. These options control the behavior of the update process, rather than defining the desired end-state of a cluster. # Optional. UpdateOptions represents options that control how updates to the cluster are applied. + "allowBrokerDownscaleOnClusterUpscale": True or False, # Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size. + }, "updateTime": "A String", # Output only. The time when the cluster was last updated. } diff --git a/googleapiclient/discovery_cache/documents/managedkafka.v1.json b/googleapiclient/discovery_cache/documents/managedkafka.v1.json index 96920e22844..7efb0d43c20 100644 --- a/googleapiclient/discovery_cache/documents/managedkafka.v1.json +++ b/googleapiclient/discovery_cache/documents/managedkafka.v1.json @@ -2934,7 +2934,7 @@ } } }, -"revision": "20250814", +"revision": "20250901", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -3180,6 +3180,10 @@ "$ref": "TlsConfig", "description": "Optional. TLS configuration for the Kafka cluster." }, +"updateOptions": { +"$ref": "UpdateOptions", +"description": "Optional. UpdateOptions represents options that control how updates to the cluster are applied." +}, "updateTime": { "description": "Output only. The time when the cluster was last updated.", "format": "google-datetime", @@ -4260,6 +4264,17 @@ }, "type": "object" }, +"UpdateOptions": { +"description": "UpdateOptions specifies options that influence how a cluster update is applied. These options control the behavior of the update process, rather than defining the desired end-state of a cluster.", +"id": "UpdateOptions", +"properties": { +"allowBrokerDownscaleOnClusterUpscale": { +"description": "Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size.", +"type": "boolean" +} +}, +"type": "object" +}, "UpdateSchemaConfigRequest": { "description": "Request for updating schema config. On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig.", "id": "UpdateSchemaConfigRequest", From efea6f877e544a100d11e1fcc7cbe469fe861043 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 19/27] feat(netapp): update the api #### netapp:v1 The following keys were added: - schemas.StoragePool.properties.coldTierSizeUsedGib (Total Keys: 3) - schemas.StoragePool.properties.hotTierSizeUsedGib (Total Keys: 3) - schemas.Volume.properties.hotTierSizeUsedGib (Total Keys: 3) #### netapp:v1beta1 The following keys were added: - schemas.StoragePool.properties.coldTierSizeUsedGib (Total Keys: 3) - schemas.StoragePool.properties.hotTierSizeUsedGib (Total Keys: 3) - schemas.Volume.properties.hotTierSizeUsedGib (Total Keys: 3) --- ...pp_v1.projects.locations.storagePools.html | 8 ++++++++ .../netapp_v1.projects.locations.volumes.html | 4 ++++ ...beta1.projects.locations.storagePools.html | 8 ++++++++ ...pp_v1beta1.projects.locations.volumes.html | 4 ++++ .../discovery_cache/documents/netapp.v1.json | 20 ++++++++++++++++++- .../documents/netapp.v1beta1.json | 20 ++++++++++++++++++- 6 files changed, 62 insertions(+), 2 deletions(-) diff --git a/docs/dyn/netapp_v1.projects.locations.storagePools.html b/docs/dyn/netapp_v1.projects.locations.storagePools.html index 3b641e9769c..cb0a5b6c1e2 100644 --- a/docs/dyn/netapp_v1.projects.locations.storagePools.html +++ b/docs/dyn/netapp_v1.projects.locations.storagePools.html @@ -121,6 +121,7 @@

Method Details

"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled. "availableThroughputMibps": 3.14, # Output only. Available throughput of the storage pool (in MiB/s). "capacityGib": "A String", # Required. Capacity in GIB of the pool + "coldTierSizeUsedGib": "A String", # Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. "createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool @@ -128,6 +129,7 @@

Method Details

"encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", @@ -234,6 +236,7 @@

Method Details

"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled. "availableThroughputMibps": 3.14, # Output only. Available throughput of the storage pool (in MiB/s). "capacityGib": "A String", # Required. Capacity in GIB of the pool + "coldTierSizeUsedGib": "A String", # Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. "createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool @@ -241,6 +244,7 @@

Method Details

"encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", @@ -290,6 +294,7 @@

Method Details

"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled. "availableThroughputMibps": 3.14, # Output only. Available throughput of the storage pool (in MiB/s). "capacityGib": "A String", # Required. Capacity in GIB of the pool + "coldTierSizeUsedGib": "A String", # Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. "createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool @@ -297,6 +302,7 @@

Method Details

"encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", @@ -353,6 +359,7 @@

Method Details

"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled. "availableThroughputMibps": 3.14, # Output only. Available throughput of the storage pool (in MiB/s). "capacityGib": "A String", # Required. Capacity in GIB of the pool + "coldTierSizeUsedGib": "A String", # Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. "createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool @@ -360,6 +367,7 @@

Method Details

"encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.html b/docs/dyn/netapp_v1.projects.locations.volumes.html index dbe1f4de2d8..fca059cf8d5 100644 --- a/docs/dyn/netapp_v1.projects.locations.volumes.html +++ b/docs/dyn/netapp_v1.projects.locations.volumes.html @@ -161,6 +161,7 @@

Method Details

], }, "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level "hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume. "clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only. "description": "A String", # Optional. Description of the replication. @@ -368,6 +369,7 @@

Method Details

], }, "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level "hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume. "clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only. "description": "A String", # Optional. Description of the replication. @@ -520,6 +522,7 @@

Method Details

], }, "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level "hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume. "clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only. "description": "A String", # Optional. Description of the replication. @@ -673,6 +676,7 @@

Method Details

], }, "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level "hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume. "clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only. "description": "A String", # Optional. Description of the replication. diff --git a/docs/dyn/netapp_v1beta1.projects.locations.storagePools.html b/docs/dyn/netapp_v1beta1.projects.locations.storagePools.html index 2c2d7d9c32d..3b79e334ad9 100644 --- a/docs/dyn/netapp_v1beta1.projects.locations.storagePools.html +++ b/docs/dyn/netapp_v1beta1.projects.locations.storagePools.html @@ -121,6 +121,7 @@

Method Details

"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled. "availableThroughputMibps": 3.14, # Output only. Available throughput of the storage pool (in MiB/s). "capacityGib": "A String", # Required. Capacity in GIB of the pool + "coldTierSizeUsedGib": "A String", # Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. "createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool @@ -128,6 +129,7 @@

Method Details

"encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", @@ -234,6 +236,7 @@

Method Details

"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled. "availableThroughputMibps": 3.14, # Output only. Available throughput of the storage pool (in MiB/s). "capacityGib": "A String", # Required. Capacity in GIB of the pool + "coldTierSizeUsedGib": "A String", # Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. "createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool @@ -241,6 +244,7 @@

Method Details

"encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", @@ -290,6 +294,7 @@

Method Details

"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled. "availableThroughputMibps": 3.14, # Output only. Available throughput of the storage pool (in MiB/s). "capacityGib": "A String", # Required. Capacity in GIB of the pool + "coldTierSizeUsedGib": "A String", # Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. "createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool @@ -297,6 +302,7 @@

Method Details

"encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", @@ -353,6 +359,7 @@

Method Details

"allowAutoTiering": True or False, # Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled. "availableThroughputMibps": 3.14, # Output only. Available throughput of the storage pool (in MiB/s). "capacityGib": "A String", # Required. Capacity in GIB of the pool + "coldTierSizeUsedGib": "A String", # Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. "createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool @@ -360,6 +367,7 @@

Method Details

"encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", diff --git a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html index 6f3f7ffb31d..a345cce8ad3 100644 --- a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html +++ b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html @@ -184,6 +184,7 @@

Method Details

], }, "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level "hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume. "clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only. "description": "A String", # Optional. Description of the replication. @@ -455,6 +456,7 @@

Method Details

], }, "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level "hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume. "clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only. "description": "A String", # Optional. Description of the replication. @@ -624,6 +626,7 @@

Method Details

], }, "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level "hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume. "clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only. "description": "A String", # Optional. Description of the replication. @@ -794,6 +797,7 @@

Method Details

], }, "hasReplication": True or False, # Output only. Indicates whether the volume is part of a replication relationship. + "hotTierSizeUsedGib": "A String", # Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level "hybridReplicationParameters": { # The Hybrid Replication parameters for the volume. # Optional. The Hybrid Replication parameters for the volume. "clusterLocation": "A String", # Optional. Name of source cluster location associated with the Hybrid replication. This is a free-form field for the display purpose only. "description": "A String", # Optional. Description of the replication. diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json index 25b54e4daa3..435370e9008 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -2270,7 +2270,7 @@ } } }, -"revision": "20250817", +"revision": "20250901", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -4089,6 +4089,12 @@ "format": "int64", "type": "string" }, +"coldTierSizeUsedGib": { +"description": "Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "createTime": { "description": "Output only. Create time of the storage pool", "format": "google-datetime", @@ -4132,6 +4138,12 @@ "format": "int64", "type": "string" }, +"hotTierSizeUsedGib": { +"description": "Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "kmsConfig": { "description": "Optional. Specifies the KMS config to be used for volume encryption.", "type": "string" @@ -4472,6 +4484,12 @@ "readOnly": true, "type": "boolean" }, +"hotTierSizeUsedGib": { +"description": "Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level", +"format": "int64", +"readOnly": true, +"type": "string" +}, "hybridReplicationParameters": { "$ref": "HybridReplicationParameters", "description": "Optional. The Hybrid Replication parameters for the volume." diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json index 692e4f12288..37e92e4b486 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json @@ -2326,7 +2326,7 @@ } } }, -"revision": "20250817", +"revision": "20250901", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -4277,6 +4277,12 @@ "format": "int64", "type": "string" }, +"coldTierSizeUsedGib": { +"description": "Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "createTime": { "description": "Output only. Create time of the storage pool", "format": "google-datetime", @@ -4320,6 +4326,12 @@ "format": "int64", "type": "string" }, +"hotTierSizeUsedGib": { +"description": "Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "kmsConfig": { "description": "Optional. Specifies the KMS config to be used for volume encryption.", "type": "string" @@ -4664,6 +4676,12 @@ "readOnly": true, "type": "boolean" }, +"hotTierSizeUsedGib": { +"description": "Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level", +"format": "int64", +"readOnly": true, +"type": "string" +}, "hybridReplicationParameters": { "$ref": "HybridReplicationParameters", "description": "Optional. The Hybrid Replication parameters for the volume." From 08bd8ae0c81acc83a24c3cae983317f62ab6f436 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 20/27] feat(networkmanagement): update the api #### networkmanagement:v1 The following keys were added: - schemas.HybridSubnetInfo (Total Keys: 5) - schemas.InterconnectAttachmentInfo.properties.l2AttachmentMatchedIpAddress.type (Total Keys: 1) - schemas.InterconnectAttachmentInfo.properties.type.type (Total Keys: 1) - schemas.Step.properties.hybridSubnet.$ref (Total Keys: 1) #### networkmanagement:v1beta1 The following keys were added: - schemas.HybridSubnetInfo (Total Keys: 5) - schemas.InterconnectAttachmentInfo.properties.l2AttachmentMatchedIpAddress.type (Total Keys: 1) - schemas.InterconnectAttachmentInfo.properties.type.type (Total Keys: 1) - schemas.Step.properties.hybridSubnet.$ref (Total Keys: 1) --- ...s.locations.global_.connectivityTests.html | 56 +++++++++++++++++ ...s.locations.global_.connectivityTests.html | 56 +++++++++++++++++ .../documents/networkmanagement.v1.json | 60 ++++++++++++++++++- .../documents/networkmanagement.v1beta1.json | 60 ++++++++++++++++++- 4 files changed, 226 insertions(+), 6 deletions(-) diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index 1f6c047ba1b..e432c4c968d 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -360,6 +360,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -379,7 +384,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -686,6 +693,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -705,7 +717,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -1213,6 +1227,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -1232,7 +1251,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -1539,6 +1560,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -1558,7 +1584,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2057,6 +2085,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -2076,7 +2109,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2383,6 +2418,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -2402,7 +2442,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2860,6 +2902,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -2879,7 +2926,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -3186,6 +3235,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -3205,7 +3259,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index b3191fcd51a..b60132c109c 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -361,6 +361,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -380,7 +385,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -687,6 +694,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -706,7 +718,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -1216,6 +1230,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -1235,7 +1254,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -1542,6 +1563,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -1561,7 +1587,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2062,6 +2090,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -2081,7 +2114,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2388,6 +2423,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -2407,7 +2447,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2867,6 +2909,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -2886,7 +2933,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -3193,6 +3242,11 @@

Method Details

"googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. }, + "hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. + "displayName": "A String", # Name of a hybrid subnet. + "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. + "uri": "A String", # URI of a hybrid subnet. + }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. @@ -3212,7 +3266,9 @@

Method Details

"cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. "displayName": "A String", # Name of an Interconnect attachment. "interconnectUri": "A String", # URI of the Interconnect where the Interconnect attachment is configured. + "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. + "type": "A String", # The type of interconnect attachment this is. "uri": "A String", # URI of an Interconnect attachment. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 400d7e4d1ed..067a75ba1a9 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -1289,7 +1289,7 @@ } } }, -"revision": "20250813", +"revision": "20250901", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1951,7 +1951,10 @@ false "NO_MATCHING_NAT64_GATEWAY", "LOAD_BALANCER_BACKEND_IP_VERSION_MISMATCH", "NO_KNOWN_ROUTE_FROM_NCC_NETWORK_TO_DESTINATION", -"CLOUD_NAT_PROTOCOL_UNSUPPORTED" +"CLOUD_NAT_PROTOCOL_UNSUPPORTED", +"L2_INTERCONNECT_UNSUPPORTED_PROTOCOL", +"L2_INTERCONNECT_UNSUPPORTED_PORT", +"L2_INTERCONNECT_DESTINATION_IP_MISMATCH" ], "enumDescriptions": [ "Cause is unspecified.", @@ -2047,7 +2050,10 @@ false "Packet with destination IP address within the reserved NAT64 range is dropped due to no matching NAT gateway in the subnet.", "Packet is dropped due to being sent to a backend of a passthrough load balancer that doesn't use the same IP version as the frontend.", "Packet from the unknown NCC network is dropped due to no known route from the source network to the destination IP address.", -"Packet is dropped by Cloud NAT due to using an unsupported protocol." +"Packet is dropped by Cloud NAT due to using an unsupported protocol.", +"Packet is dropped due to using an unsupported protocol (any other than UDP) for L2 Interconnect.", +"Packet is dropped due to using an unsupported port (any other than 6081) for L2 Interconnect.", +"Packet is dropped due to destination IP not matching the appliance mapping IPs configured on the L2 Interconnect attachment." ], "type": "string" }, @@ -2629,6 +2635,25 @@ false }, "type": "object" }, +"HybridSubnetInfo": { +"description": "For display only. Metadata associated with a hybrid subnet.", +"id": "HybridSubnetInfo", +"properties": { +"displayName": { +"description": "Name of a hybrid subnet.", +"type": "string" +}, +"region": { +"description": "Name of a Google Cloud region where the hybrid subnet is configured.", +"type": "string" +}, +"uri": { +"description": "URI of a hybrid subnet.", +"type": "string" +} +}, +"type": "object" +}, "InstanceInfo": { "description": "For display only. Metadata associated with a Compute Engine instance.", "id": "InstanceInfo", @@ -2711,10 +2736,32 @@ false "description": "URI of the Interconnect where the Interconnect attachment is configured.", "type": "string" }, +"l2AttachmentMatchedIpAddress": { +"description": "Appliance IP address that was matched for L2_DEDICATED attachments.", +"type": "string" +}, "region": { "description": "Name of a Google Cloud region where the Interconnect attachment is configured.", "type": "string" }, +"type": { +"description": "The type of interconnect attachment this is.", +"enum": [ +"TYPE_UNSPECIFIED", +"DEDICATED", +"PARTNER", +"PARTNER_PROVIDER", +"L2_DEDICATED" +], +"enumDescriptions": [ +"Unspecified type.", +"Attachment to a dedicated interconnect.", +"Attachment to a partner interconnect, created by the customer.", +"Attachment to a partner interconnect, created by the partner.", +"Attachment to a L2 interconnect, created by the customer." +], +"type": "string" +}, "uri": { "description": "URI of an Interconnect attachment.", "type": "string" @@ -4328,6 +4375,10 @@ false "$ref": "GoogleServiceInfo", "description": "Display information of a Google service" }, +"hybridSubnet": { +"$ref": "HybridSubnetInfo", +"description": "Display information of a hybrid subnet." +}, "instance": { "$ref": "InstanceInfo", "description": "Display information of a Compute Engine instance." @@ -4408,6 +4459,7 @@ false "ARRIVE_AT_INSTANCE", "ARRIVE_AT_INTERNAL_LOAD_BALANCER", "ARRIVE_AT_EXTERNAL_LOAD_BALANCER", +"ARRIVE_AT_HYBRID_SUBNET", "ARRIVE_AT_VPN_GATEWAY", "ARRIVE_AT_VPN_TUNNEL", "ARRIVE_AT_INTERCONNECT_ATTACHMENT", @@ -4459,6 +4511,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4486,6 +4539,7 @@ false "Forwarding state: arriving at a Compute Engine instance.", "Forwarding state: arriving at a Compute Engine internal load balancer.", "Forwarding state: arriving at a Compute Engine external load balancer.", +"Forwarding state: arriving at a hybrid subnet. Appropriate routing configuration will be determined here.", "Forwarding state: arriving at a Cloud VPN gateway.", "Forwarding state: arriving at a Cloud VPN tunnel.", "Forwarding state: arriving at an interconnect attachment.", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 19e34d07a2f..153c13e4cbd 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1181,7 +1181,7 @@ } } }, -"revision": "20250813", +"revision": "20250901", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1843,7 +1843,10 @@ false "NO_MATCHING_NAT64_GATEWAY", "LOAD_BALANCER_BACKEND_IP_VERSION_MISMATCH", "NO_KNOWN_ROUTE_FROM_NCC_NETWORK_TO_DESTINATION", -"CLOUD_NAT_PROTOCOL_UNSUPPORTED" +"CLOUD_NAT_PROTOCOL_UNSUPPORTED", +"L2_INTERCONNECT_UNSUPPORTED_PROTOCOL", +"L2_INTERCONNECT_UNSUPPORTED_PORT", +"L2_INTERCONNECT_DESTINATION_IP_MISMATCH" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1939,7 +1942,10 @@ false "Packet with destination IP address within the reserved NAT64 range is dropped due to no matching NAT gateway in the subnet.", "Packet is dropped due to being sent to a backend of a passthrough load balancer that doesn't use the same IP version as the frontend.", "Packet from the unknown NCC network is dropped due to no known route from the source network to the destination IP address.", -"Packet is dropped by Cloud NAT due to using an unsupported protocol." +"Packet is dropped by Cloud NAT due to using an unsupported protocol.", +"Packet is dropped due to using an unsupported protocol (any other than UDP) for L2 Interconnect.", +"Packet is dropped due to using an unsupported port (any other than 6081) for L2 Interconnect.", +"Packet is dropped due to destination IP not matching the appliance mapping IPs configured on the L2 Interconnect attachment." ], "type": "string" }, @@ -2460,6 +2466,25 @@ false }, "type": "object" }, +"HybridSubnetInfo": { +"description": "For display only. Metadata associated with a hybrid subnet.", +"id": "HybridSubnetInfo", +"properties": { +"displayName": { +"description": "Name of a hybrid subnet.", +"type": "string" +}, +"region": { +"description": "Name of a Google Cloud region where the hybrid subnet is configured.", +"type": "string" +}, +"uri": { +"description": "URI of a hybrid subnet.", +"type": "string" +} +}, +"type": "object" +}, "InstanceInfo": { "description": "For display only. Metadata associated with a Compute Engine instance.", "id": "InstanceInfo", @@ -2542,10 +2567,32 @@ false "description": "URI of the Interconnect where the Interconnect attachment is configured.", "type": "string" }, +"l2AttachmentMatchedIpAddress": { +"description": "Appliance IP address that was matched for L2_DEDICATED attachments.", +"type": "string" +}, "region": { "description": "Name of a Google Cloud region where the Interconnect attachment is configured.", "type": "string" }, +"type": { +"description": "The type of interconnect attachment this is.", +"enum": [ +"TYPE_UNSPECIFIED", +"DEDICATED", +"PARTNER", +"PARTNER_PROVIDER", +"L2_DEDICATED" +], +"enumDescriptions": [ +"Unspecified type.", +"Attachment to a dedicated interconnect.", +"Attachment to a partner interconnect, created by the customer.", +"Attachment to a partner interconnect, created by the partner.", +"Attachment to a L2 interconnect, created by the customer." +], +"type": "string" +}, "uri": { "description": "URI of an Interconnect attachment.", "type": "string" @@ -3708,6 +3755,10 @@ false "$ref": "GoogleServiceInfo", "description": "Display information of a Google service" }, +"hybridSubnet": { +"$ref": "HybridSubnetInfo", +"description": "Display information of a hybrid subnet." +}, "instance": { "$ref": "InstanceInfo", "description": "Display information of a Compute Engine instance." @@ -3788,6 +3839,7 @@ false "ARRIVE_AT_INSTANCE", "ARRIVE_AT_INTERNAL_LOAD_BALANCER", "ARRIVE_AT_EXTERNAL_LOAD_BALANCER", +"ARRIVE_AT_HYBRID_SUBNET", "ARRIVE_AT_VPN_GATEWAY", "ARRIVE_AT_VPN_TUNNEL", "ARRIVE_AT_INTERCONNECT_ATTACHMENT", @@ -3839,6 +3891,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3866,6 +3919,7 @@ false "Forwarding state: arriving at a Compute Engine instance.", "Forwarding state: arriving at a Compute Engine internal load balancer. Deprecated in favor of the `ANALYZE_LOAD_BALANCER_BACKEND` state, not used in new tests.", "Forwarding state: arriving at a Compute Engine external load balancer. Deprecated in favor of the `ANALYZE_LOAD_BALANCER_BACKEND` state, not used in new tests.", +"Forwarding state: arriving at a hybrid subnet. Appropriate routing configuration will be determined here.", "Forwarding state: arriving at a Cloud VPN gateway.", "Forwarding state: arriving at a Cloud VPN tunnel.", "Forwarding state: arriving at an interconnect attachment.", From 8018b9785ee0d7009b4becdffd9e2018405e3d8e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 21/27] feat(oracledatabase): update the api #### oracledatabase:v1 The following keys were added: - schemas.CloudVmCluster.properties.identityConnector (Total Keys: 2) - schemas.IdentityConnector (Total Keys: 6) --- ...v1.projects.locations.cloudVmClusters.html | 12 ++++++ .../documents/oracledatabase.v1.json | 38 ++++++++++++++++++- 2 files changed, 49 insertions(+), 1 deletion(-) diff --git a/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html b/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html index 359d557520b..53f2ceaf62f 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html @@ -120,6 +120,10 @@

Method Details

"displayName": "A String", # Optional. User friendly name for this resource. "exadataInfrastructure": "A String", # Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure} "gcpOracleZone": "A String", # Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2. + "identityConnector": { # The identity connector details which will allow OCI to securely access the resources in the customer project. # Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. + "connectionState": "A String", # Output only. The connection state of the identity connector. + "serviceAgentEmail": "A String", # Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` + }, "labels": { # Optional. Labels or tags associated with the VM Cluster. "a_key": "A String", }, @@ -267,6 +271,10 @@

Method Details

"displayName": "A String", # Optional. User friendly name for this resource. "exadataInfrastructure": "A String", # Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure} "gcpOracleZone": "A String", # Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2. + "identityConnector": { # The identity connector details which will allow OCI to securely access the resources in the customer project. # Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. + "connectionState": "A String", # Output only. The connection state of the identity connector. + "serviceAgentEmail": "A String", # Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` + }, "labels": { # Optional. Labels or tags associated with the VM Cluster. "a_key": "A String", }, @@ -352,6 +360,10 @@

Method Details

"displayName": "A String", # Optional. User friendly name for this resource. "exadataInfrastructure": "A String", # Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure} "gcpOracleZone": "A String", # Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2. + "identityConnector": { # The identity connector details which will allow OCI to securely access the resources in the customer project. # Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. + "connectionState": "A String", # Output only. The connection state of the identity connector. + "serviceAgentEmail": "A String", # Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` + }, "labels": { # Optional. Labels or tags associated with the VM Cluster. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index c5f1c632b4b..0ce7a2da737 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -1530,7 +1530,7 @@ } } }, -"revision": "20250825", +"revision": "20250901", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -2902,6 +2902,11 @@ "readOnly": true, "type": "string" }, +"identityConnector": { +"$ref": "IdentityConnector", +"description": "Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.", +"readOnly": true +}, "labels": { "additionalProperties": { "type": "string" @@ -3658,6 +3663,37 @@ }, "type": "object" }, +"IdentityConnector": { +"description": "The identity connector details which will allow OCI to securely access the resources in the customer project.", +"id": "IdentityConnector", +"properties": { +"connectionState": { +"description": "Output only. The connection state of the identity connector.", +"enum": [ +"CONNECTION_STATE_UNSPECIFIED", +"CONNECTED", +"PARTIALLY_CONNECTED", +"DISCONNECTED", +"UNKNOWN" +], +"enumDescriptions": [ +"Default unspecified value.", +"The identity pool connection is connected.", +"The identity pool connection is partially connected.", +"The identity pool connection is disconnected.", +"The identity pool connection is in an unknown state." +], +"readOnly": true, +"type": "string" +}, +"serviceAgentEmail": { +"description": "Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com`", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ListAutonomousDatabaseBackupsResponse": { "description": "The response for `AutonomousDatabaseBackup.List`.", "id": "ListAutonomousDatabaseBackupsResponse", From 6a1651c96807edc2d7c6e6c47fa9c1b619104591 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 22/27] feat(privateca): update the api #### privateca:v1 The following keys were deleted: - schemas.ReconciliationOperationMetadata (Total Keys: 5) The following keys were added: - schemas.CaPool.properties.encryptionSpec.$ref (Total Keys: 1) - schemas.EncryptionSpec (Total Keys: 3) #### privateca:v1beta1 The following keys were deleted: - schemas.ReconciliationOperationMetadata (Total Keys: 5) --- ...ivateca_v1.projects.locations.caPools.html | 12 +++++ docs/dyn/privateca_v1.projects.locations.html | 2 +- .../privateca_v1beta1.projects.locations.html | 2 +- .../documents/privateca.v1.json | 50 +++++++------------ .../documents/privateca.v1beta1.json | 35 +------------ 5 files changed, 33 insertions(+), 68 deletions(-) diff --git a/docs/dyn/privateca_v1.projects.locations.caPools.html b/docs/dyn/privateca_v1.projects.locations.caPools.html index 6875f6c884f..4c8e49dce9c 100644 --- a/docs/dyn/privateca_v1.projects.locations.caPools.html +++ b/docs/dyn/privateca_v1.projects.locations.caPools.html @@ -133,6 +133,9 @@

Method Details

The object takes the form of: { # A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. + "encryptionSpec": { # The configuration used for encrypting data at rest. # Optional. When EncryptionSpec is provided, the Subject, SubjectAltNames, and the PEM-encoded certificate fields will be encrypted at rest. + "cloudKmsKey": "A String", # The resource name for a Cloud KMS key in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + }, "issuancePolicy": { # Defines controls over all certificate issuance within a CaPool. # Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. "allowedIssuanceModes": { # IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool. # Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates. "allowConfigBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CertificateConfig. @@ -383,6 +386,9 @@

Method Details

An object of the form: { # A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. + "encryptionSpec": { # The configuration used for encrypting data at rest. # Optional. When EncryptionSpec is provided, the Subject, SubjectAltNames, and the PEM-encoded certificate fields will be encrypted at rest. + "cloudKmsKey": "A String", # The resource name for a Cloud KMS key in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + }, "issuancePolicy": { # Defines controls over all certificate issuance within a CaPool. # Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. "allowedIssuanceModes": { # IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool. # Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates. "allowConfigBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CertificateConfig. @@ -588,6 +594,9 @@

Method Details

{ # Response message for CertificateAuthorityService.ListCaPools. "caPools": [ # The list of CaPools. { # A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. + "encryptionSpec": { # The configuration used for encrypting data at rest. # Optional. When EncryptionSpec is provided, the Subject, SubjectAltNames, and the PEM-encoded certificate fields will be encrypted at rest. + "cloudKmsKey": "A String", # The resource name for a Cloud KMS key in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + }, "issuancePolicy": { # Defines controls over all certificate issuance within a CaPool. # Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. "allowedIssuanceModes": { # IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool. # Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates. "allowConfigBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CertificateConfig. @@ -754,6 +763,9 @@

Method Details

The object takes the form of: { # A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. + "encryptionSpec": { # The configuration used for encrypting data at rest. # Optional. When EncryptionSpec is provided, the Subject, SubjectAltNames, and the PEM-encoded certificate fields will be encrypted at rest. + "cloudKmsKey": "A String", # The resource name for a Cloud KMS key in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + }, "issuancePolicy": { # Defines controls over all certificate issuance within a CaPool. # Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. "allowedIssuanceModes": { # IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool. # Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates. "allowConfigBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CertificateConfig. diff --git a/docs/dyn/privateca_v1.projects.locations.html b/docs/dyn/privateca_v1.projects.locations.html index 1f34afb9f31..b8ca782f2f5 100644 --- a/docs/dyn/privateca_v1.projects.locations.html +++ b/docs/dyn/privateca_v1.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/privateca_v1beta1.projects.locations.html b/docs/dyn/privateca_v1beta1.projects.locations.html index 30f4295635b..d13894bdd0b 100644 --- a/docs/dyn/privateca_v1beta1.projects.locations.html +++ b/docs/dyn/privateca_v1beta1.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/privateca.v1.json b/googleapiclient/discovery_cache/documents/privateca.v1.json index ea465080d6f..b837643e7c5 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1611,7 +1611,7 @@ } } }, -"revision": "20250528", +"revision": "20250901", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -1797,6 +1797,10 @@ "description": "A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor.", "id": "CaPool", "properties": { +"encryptionSpec": { +"$ref": "EncryptionSpec", +"description": "Optional. When EncryptionSpec is provided, the Subject, SubjectAltNames, and the PEM-encoded certificate fields will be encrypted at rest." +}, "issuancePolicy": { "$ref": "IssuancePolicy", "description": "Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool." @@ -2423,6 +2427,17 @@ }, "type": "object" }, +"EncryptionSpec": { +"description": "The configuration used for encrypting data at rest.", +"id": "EncryptionSpec", +"properties": { +"cloudKmsKey": { +"description": "The resource name for a Cloud KMS key in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", +"type": "string" +} +}, +"type": "object" +}, "Expr": { "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", @@ -3122,37 +3137,6 @@ }, "type": "object" }, -"ReconciliationOperationMetadata": { -"description": "Operation metadata returned by the CLH during resource state reconciliation.", -"id": "ReconciliationOperationMetadata", -"properties": { -"deleteResource": { -"deprecated": true, -"description": "DEPRECATED. Use exclusive_action instead.", -"type": "boolean" -}, -"exclusiveAction": { -"description": "Excluisive action returned by the CLH.", -"enum": [ -"UNKNOWN_REPAIR_ACTION", -"DELETE", -"RETRY" -], -"enumDeprecated": [ -false, -true, -false -], -"enumDescriptions": [ -"Unknown repair action.", -"The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", -"This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." -], -"type": "string" -} -}, -"type": "object" -}, "RelativeDistinguishedName": { "description": "RelativeDistinguishedName specifies a relative distinguished name which will be used to build a distinguished name.", "id": "RelativeDistinguishedName", diff --git a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json index a3a090b771d..1a6a7cb7441 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -586,7 +586,7 @@ } } }, -"revision": "20250326", +"revision": "20250901", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { @@ -830,37 +830,6 @@ }, "type": "object" }, -"ReconciliationOperationMetadata": { -"description": "Operation metadata returned by the CLH during resource state reconciliation.", -"id": "ReconciliationOperationMetadata", -"properties": { -"deleteResource": { -"deprecated": true, -"description": "DEPRECATED. Use exclusive_action instead.", -"type": "boolean" -}, -"exclusiveAction": { -"description": "Excluisive action returned by the CLH.", -"enum": [ -"UNKNOWN_REPAIR_ACTION", -"DELETE", -"RETRY" -], -"enumDeprecated": [ -false, -true, -false -], -"enumDescriptions": [ -"Unknown repair action.", -"The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", -"This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." -], -"type": "string" -} -}, -"type": "object" -}, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", From c54c46b3a3ae735c88bd69cf62eed963ceab0d4a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 23/27] feat(redis): update the api #### redis:v1 The following keys were added: - schemas.Cluster.properties.labels (Total Keys: 2) #### redis:v1beta1 The following keys were added: - schemas.Cluster.properties.labels (Total Keys: 2) --- .../dyn/redis_v1.projects.locations.clusters.html | 12 ++++++++++++ ...redis_v1beta1.projects.locations.clusters.html | 12 ++++++++++++ .../discovery_cache/documents/redis.v1.json | 15 ++++++++++++--- .../discovery_cache/documents/redis.v1beta1.json | 15 ++++++++++++--- 4 files changed, 48 insertions(+), 6 deletions(-) diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html index 71998805f49..77ddc2b1d2b 100644 --- a/docs/dyn/redis_v1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1.projects.locations.clusters.html @@ -259,6 +259,9 @@

Method Details

], }, "kmsKey": "A String", # Optional. The KMS key used to encrypt the at-rest data of the cluster. + "labels": { # Optional. Labels to represent user-provided metadata. + "a_key": "A String", + }, "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. @@ -522,6 +525,9 @@

Method Details

], }, "kmsKey": "A String", # Optional. The KMS key used to encrypt the at-rest data of the cluster. + "labels": { # Optional. Labels to represent user-provided metadata. + "a_key": "A String", + }, "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. @@ -751,6 +757,9 @@

Method Details

], }, "kmsKey": "A String", # Optional. The KMS key used to encrypt the at-rest data of the cluster. + "labels": { # Optional. Labels to represent user-provided metadata. + "a_key": "A String", + }, "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. @@ -963,6 +972,9 @@

Method Details

], }, "kmsKey": "A String", # Optional. The KMS key used to encrypt the at-rest data of the cluster. + "labels": { # Optional. Labels to represent user-provided metadata. + "a_key": "A String", + }, "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index 7925d397dd8..41accd1400d 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -259,6 +259,9 @@

Method Details

], }, "kmsKey": "A String", # Optional. The KMS key used to encrypt the at-rest data of the cluster. + "labels": { # Optional. Labels to represent user-provided metadata. + "a_key": "A String", + }, "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. @@ -522,6 +525,9 @@

Method Details

], }, "kmsKey": "A String", # Optional. The KMS key used to encrypt the at-rest data of the cluster. + "labels": { # Optional. Labels to represent user-provided metadata. + "a_key": "A String", + }, "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. @@ -751,6 +757,9 @@

Method Details

], }, "kmsKey": "A String", # Optional. The KMS key used to encrypt the at-rest data of the cluster. + "labels": { # Optional. Labels to represent user-provided metadata. + "a_key": "A String", + }, "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. @@ -963,6 +972,9 @@

Method Details

], }, "kmsKey": "A String", # Optional. The KMS key used to encrypt the at-rest data of the cluster. + "labels": { # Optional. Labels to represent user-provided metadata. + "a_key": "A String", + }, "maintenancePolicy": { # Maintenance policy per cluster. # Optional. ClusterMaintenancePolicy determines when to allow or deny updates. "createTime": "A String", # Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. "updateTime": "A String", # Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index c569c839fe8..bfc47f61461 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -1073,7 +1073,7 @@ } } }, -"revision": "20250825", +"revision": "20250902", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1592,6 +1592,13 @@ "description": "Optional. The KMS key used to encrypt the at-rest data of the cluster.", "type": "string" }, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels to represent user-provided metadata.", +"type": "object" +}, "maintenancePolicy": { "$ref": "ClusterMaintenancePolicy", "description": "Optional. ClusterMaintenancePolicy determines when to allow or deny updates." @@ -2615,12 +2622,14 @@ false "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", -"EDITION_ENTERPRISE_PLUS" +"EDITION_ENTERPRISE_PLUS", +"EDITION_STANDARD" ], "enumDescriptions": [ "Default, to make it consistent with instance edition enum.", "Represents the enterprise edition.", -"Represents the enterprise plus edition." +"Represents the enterprise plus edition.", +"Represents the standard edition." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index bdfcc7dc594..61e2a1d8160 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -1073,7 +1073,7 @@ } } }, -"revision": "20250825", +"revision": "20250902", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1592,6 +1592,13 @@ "description": "Optional. The KMS key used to encrypt the at-rest data of the cluster.", "type": "string" }, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels to represent user-provided metadata.", +"type": "object" +}, "maintenancePolicy": { "$ref": "ClusterMaintenancePolicy", "description": "Optional. ClusterMaintenancePolicy determines when to allow or deny updates." @@ -2615,12 +2622,14 @@ false "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", -"EDITION_ENTERPRISE_PLUS" +"EDITION_ENTERPRISE_PLUS", +"EDITION_STANDARD" ], "enumDescriptions": [ "Default, to make it consistent with instance edition enum.", "Represents the enterprise edition.", -"Represents the enterprise plus edition." +"Represents the enterprise plus edition.", +"Represents the standard edition." ], "type": "string" }, From 0603894c36b32138db3ba2b8e470d72a289c82bf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:10 +0000 Subject: [PATCH 24/27] feat(servicecontrol): update the api #### servicecontrol:v1 The following keys were added: - schemas.Auth.properties.oauth.$ref (Total Keys: 1) - schemas.AuthenticationInfo.properties.loggableShortLivedCredential (Total Keys: 2) - schemas.AuthenticationInfo.properties.oauthInfo.$ref (Total Keys: 1) - schemas.CheckInfo.properties.ignoreApiKeyUidAsCredentialId.type (Total Keys: 1) - schemas.OAuthInfo (Total Keys: 3) - schemas.Oauth (Total Keys: 3) #### servicecontrol:v2 The following keys were added: - schemas.Auth.properties.oauth.$ref (Total Keys: 1) - schemas.AuthenticationInfo.properties.loggableShortLivedCredential (Total Keys: 2) - schemas.AuthenticationInfo.properties.oauthInfo.$ref (Total Keys: 1) - schemas.OAuthInfo (Total Keys: 3) - schemas.Oauth (Total Keys: 3) --- docs/dyn/servicecontrol_v1.services.html | 1 + docs/dyn/servicecontrol_v2.services.html | 10 +++- .../documents/servicecontrol.v1.json | 46 ++++++++++++++++++- .../documents/servicecontrol.v2.json | 42 ++++++++++++++++- 4 files changed, 93 insertions(+), 6 deletions(-) diff --git a/docs/dyn/servicecontrol_v1.services.html b/docs/dyn/servicecontrol_v1.services.html index c9228eedd4a..3ca63e2ef29 100644 --- a/docs/dyn/servicecontrol_v1.services.html +++ b/docs/dyn/servicecontrol_v1.services.html @@ -478,6 +478,7 @@

Method Details

"projectNumber": "A String", # The Google cloud project number, e.g. 1234567890. A value of 0 indicates no project number is found. NOTE: This field is deprecated after Chemist support flexible consumer id. New code should not depend on this field anymore. "type": "A String", # The type of the consumer which should have been defined in [Google Resource Manager](https://cloud.google.com/resource-manager/). }, + "ignoreApiKeyUidAsCredentialId": True or False, # Whether or not the api key should be ignored in the credential_id during reporting. "unusedArguments": [ # A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation. "A String", ], diff --git a/docs/dyn/servicecontrol_v2.services.html b/docs/dyn/servicecontrol_v2.services.html index 7346f68ff17..d1f29db4a44 100644 --- a/docs/dyn/servicecontrol_v2.services.html +++ b/docs/dyn/servicecontrol_v2.services.html @@ -82,7 +82,7 @@

Instance Methods

Close httplib2 connections.

report(serviceName, body=None, x__xgafv=None)

-

This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).

+

This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 100 operations and 1MB per Report call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).

Method Details

check(serviceName, body=None, x__xgafv=None) @@ -135,6 +135,9 @@

Method Details

"claims": { # Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure. "a_key": "", # Properties of the object. }, + "oauth": { # This message defines attributes associated with OAuth credentials. # Attributes of the OAuth token associated with the request. + "clientId": "A String", # The optional OAuth client ID. This is the unique public identifier issued by an authorization server to a registered client application. Empty string is equivalent to no oauth client id. WARNING: This is for MCP tools/call and tools/list authorization and not for general use. + }, "presenter": "A String", # The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com". "principal": "A String", # The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id}" }, @@ -237,7 +240,7 @@

Method Details

report(serviceName, body=None, x__xgafv=None) -
This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
+  
This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 100 operations and 1MB per Report call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
 
 Args:
   serviceName: string, The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name. (required)
@@ -287,6 +290,9 @@ 

Method Details

"claims": { # Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure. "a_key": "", # Properties of the object. }, + "oauth": { # This message defines attributes associated with OAuth credentials. # Attributes of the OAuth token associated with the request. + "clientId": "A String", # The optional OAuth client ID. This is the unique public identifier issued by an authorization server to a registered client application. Empty string is equivalent to no oauth client id. WARNING: This is for MCP tools/call and tools/list authorization and not for general use. + }, "presenter": "A String", # The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com". "principal": "A String", # The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id}" }, diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json index f7b2852fef8..5da15afabdb 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json @@ -197,7 +197,7 @@ } } }, -"revision": "20250411", +"revision": "20250820", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -418,6 +418,10 @@ "description": "Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.", "type": "object" }, +"oauth": { +"$ref": "Oauth", +"description": "Attributes of the OAuth token associated with the request." +}, "presenter": { "description": "The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: \"123456789012.apps.googleusercontent.com\".", "type": "string" @@ -437,6 +441,18 @@ "description": "The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority.", "type": "string" }, +"loggableShortLivedCredential": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Converted from \"identity_cloudgaia.AuditLoggableShortLivedCredential\" proto. This message will be used by security, detection and response team. For context please refer to go/cg:short-lived-credential-logging. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.", +"type": "object" +}, +"oauthInfo": { +"$ref": "OAuthInfo", +"description": "OAuth authentication information such as the OAuth client ID." +}, "principalEmail": { "description": "The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id).", "type": "string" @@ -558,7 +574,7 @@ "INJECTED_ERROR" ], "enumDescriptions": [ -"This is never used in `CheckResponse`.", +"This is the default value if error code is not explicitly set. It should not be used directly.", "The consumer's project id, network container, or resource container was not found. Same as google.rpc.Code.NOT_FOUND.", "The consumer doesn't have access to the specified resource. Same as google.rpc.Code.PERMISSION_DENIED.", "Quota check failed. Same as google.rpc.Code.RESOURCE_EXHAUSTED.", @@ -625,6 +641,10 @@ "$ref": "ConsumerInfo", "description": "Consumer info of this check." }, +"ignoreApiKeyUidAsCredentialId": { +"description": "Whether or not the api key should be ignored in the credential_id during reporting.", +"type": "boolean" +}, "unusedArguments": { "description": "A list of fields and label keys that are ignored by the server. The client doesn't need to send them for following requests to improve performance and allow better aggregation.", "items": { @@ -1185,6 +1205,28 @@ }, "type": "object" }, +"OAuthInfo": { +"description": "OAuth related information about the request.", +"id": "OAuthInfo", +"properties": { +"oauthClientId": { +"description": "The OAuth client ID of the 1P or 3P application acting on behalf of the user.", +"type": "string" +} +}, +"type": "object" +}, +"Oauth": { +"description": "This message defines attributes associated with OAuth credentials.", +"id": "Oauth", +"properties": { +"clientId": { +"description": "The optional OAuth client ID. This is the unique public identifier issued by an authorization server to a registered client application. Empty string is equivalent to no oauth client id. WARNING: This is for MCP tools/call and tools/list authorization and not for general use.", +"type": "string" +} +}, +"type": "object" +}, "Operation": { "description": "Represents information regarding an operation.", "id": "Operation", diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json index a3144581f1c..3dc4e87cf33 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json @@ -139,7 +139,7 @@ ] }, "report": { -"description": "This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).", +"description": "This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 100 operations and 1MB per Report call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).", "flatPath": "v2/services/{serviceName}:report", "httpMethod": "POST", "id": "servicecontrol.services.report", @@ -169,7 +169,7 @@ } } }, -"revision": "20250425", +"revision": "20250820", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { @@ -359,6 +359,10 @@ "description": "Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.", "type": "object" }, +"oauth": { +"$ref": "Oauth", +"description": "Attributes of the OAuth token associated with the request." +}, "presenter": { "description": "The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: \"123456789012.apps.googleusercontent.com\".", "type": "string" @@ -378,6 +382,18 @@ "description": "The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority.", "type": "string" }, +"loggableShortLivedCredential": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Converted from \"identity_cloudgaia.AuditLoggableShortLivedCredential\" proto. This message will be used by security, detection and response team. For context please refer to go/cg:short-lived-credential-logging. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.", +"type": "object" +}, +"oauthInfo": { +"$ref": "OAuthInfo", +"description": "OAuth authentication information such as the OAuth client ID." +}, "principalEmail": { "description": "The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id).", "type": "string" @@ -524,6 +540,28 @@ }, "type": "object" }, +"OAuthInfo": { +"description": "OAuth related information about the request.", +"id": "OAuthInfo", +"properties": { +"oauthClientId": { +"description": "The OAuth client ID of the 1P or 3P application acting on behalf of the user.", +"type": "string" +} +}, +"type": "object" +}, +"Oauth": { +"description": "This message defines attributes associated with OAuth credentials.", +"id": "Oauth", +"properties": { +"clientId": { +"description": "The optional OAuth client ID. This is the unique public identifier issued by an authorization server to a registered client application. Empty string is equivalent to no oauth client id. WARNING: This is for MCP tools/call and tools/list authorization and not for general use.", +"type": "string" +} +}, +"type": "object" +}, "OrgPolicyViolationInfo": { "description": "Represents OrgPolicy Violation information.", "id": "OrgPolicyViolationInfo", From f6a6cbd92c14ec5eeb7168415ea0123974ebab96 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:11 +0000 Subject: [PATCH 25/27] feat(texttospeech): update the api #### texttospeech:v1 The following keys were added: - schemas.SynthesisInput.properties.prompt.type (Total Keys: 1) #### texttospeech:v1beta1 The following keys were added: - schemas.SynthesisInput.properties.prompt.type (Total Keys: 1) --- docs/dyn/texttospeech_v1.projects.locations.html | 1 + docs/dyn/texttospeech_v1.text.html | 1 + docs/dyn/texttospeech_v1beta1.projects.locations.html | 1 + docs/dyn/texttospeech_v1beta1.text.html | 1 + .../discovery_cache/documents/texttospeech.v1.json | 6 +++++- .../discovery_cache/documents/texttospeech.v1beta1.json | 6 +++++- 6 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/dyn/texttospeech_v1.projects.locations.html b/docs/dyn/texttospeech_v1.projects.locations.html index 0610ef62f03..6d5e1947272 100644 --- a/docs/dyn/texttospeech_v1.projects.locations.html +++ b/docs/dyn/texttospeech_v1.projects.locations.html @@ -130,6 +130,7 @@

Method Details

}, ], }, + "prompt": "A String", # This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions. "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/docs/dyn/texttospeech_v1.text.html b/docs/dyn/texttospeech_v1.text.html index f8aaf846040..d210a3e8610 100644 --- a/docs/dyn/texttospeech_v1.text.html +++ b/docs/dyn/texttospeech_v1.text.html @@ -127,6 +127,7 @@

Method Details

}, ], }, + "prompt": "A String", # This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions. "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/docs/dyn/texttospeech_v1beta1.projects.locations.html b/docs/dyn/texttospeech_v1beta1.projects.locations.html index 9c857c34a29..24110abfe0c 100644 --- a/docs/dyn/texttospeech_v1beta1.projects.locations.html +++ b/docs/dyn/texttospeech_v1beta1.projects.locations.html @@ -130,6 +130,7 @@

Method Details

}, ], }, + "prompt": "A String", # This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions. "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/docs/dyn/texttospeech_v1beta1.text.html b/docs/dyn/texttospeech_v1beta1.text.html index 90384e54c33..f3012ab181b 100644 --- a/docs/dyn/texttospeech_v1beta1.text.html +++ b/docs/dyn/texttospeech_v1beta1.text.html @@ -130,6 +130,7 @@

Method Details

}, ], }, + "prompt": "A String", # This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions. "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). "text": "A String", # The raw text to be synthesized. }, diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index 790e8a879a2..0ab86b7467b 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -318,7 +318,7 @@ } } }, -"revision": "20250805", +"revision": "20250903", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -622,6 +622,10 @@ "$ref": "MultiSpeakerMarkup", "description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis." }, +"prompt": { +"description": "This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions.", +"type": "string" +}, "ssml": { "description": "The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json index 1c2cb52128d..ff524f4c246 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -261,7 +261,7 @@ } } }, -"revision": "20250805", +"revision": "20250903", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -555,6 +555,10 @@ "$ref": "MultiSpeakerMarkup", "description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis." }, +"prompt": { +"description": "This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions.", +"type": "string" +}, "ssml": { "description": "The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).", "type": "string" From d95473a5a5d7f637bc2afebb3498c054507ff2a7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:11 +0000 Subject: [PATCH 26/27] feat(tpu): update the api #### tpu:v2 The following keys were added: - schemas.BootDiskConfig (Total Keys: 3) - schemas.CustomerEncryptionKey (Total Keys: 3) - schemas.Node.properties.bootDiskConfig.$ref (Total Keys: 1) #### tpu:v2alpha1 The following keys were added: - schemas.BootDiskConfig.properties.storagePool.type (Total Keys: 1) --- docs/dyn/tpu_v1.projects.locations.html | 2 +- docs/dyn/tpu_v1alpha1.projects.locations.html | 2 +- docs/dyn/tpu_v2.projects.locations.html | 2 +- docs/dyn/tpu_v2.projects.locations.nodes.html | 20 +++++++++++++ ...v2.projects.locations.queuedResources.html | 15 ++++++++++ docs/dyn/tpu_v2alpha1.projects.locations.html | 2 +- ...tpu_v2alpha1.projects.locations.nodes.html | 4 +++ ...a1.projects.locations.queuedResources.html | 3 ++ .../discovery_cache/documents/tpu.v1.json | 4 +-- .../documents/tpu.v1alpha1.json | 4 +-- .../discovery_cache/documents/tpu.v2.json | 30 +++++++++++++++++-- .../documents/tpu.v2alpha1.json | 8 +++-- 12 files changed, 84 insertions(+), 12 deletions(-) diff --git a/docs/dyn/tpu_v1.projects.locations.html b/docs/dyn/tpu_v1.projects.locations.html index 6e681fdec7e..76f30ade2ef 100644 --- a/docs/dyn/tpu_v1.projects.locations.html +++ b/docs/dyn/tpu_v1.projects.locations.html @@ -145,7 +145,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/tpu_v1alpha1.projects.locations.html b/docs/dyn/tpu_v1alpha1.projects.locations.html index 7eda0c82941..ba1dd518457 100644 --- a/docs/dyn/tpu_v1alpha1.projects.locations.html +++ b/docs/dyn/tpu_v1alpha1.projects.locations.html @@ -145,7 +145,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/tpu_v2.projects.locations.html b/docs/dyn/tpu_v2.projects.locations.html index 0618e42e6b9..772e70e2b4d 100644 --- a/docs/dyn/tpu_v2.projects.locations.html +++ b/docs/dyn/tpu_v2.projects.locations.html @@ -180,7 +180,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/tpu_v2.projects.locations.nodes.html b/docs/dyn/tpu_v2.projects.locations.nodes.html index e9994759754..13301e428cf 100644 --- a/docs/dyn/tpu_v2.projects.locations.nodes.html +++ b/docs/dyn/tpu_v2.projects.locations.nodes.html @@ -126,6 +126,11 @@

Method Details

}, "acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node. "apiVersion": "A String", # Output only. The API version that created this Node. + "bootDiskConfig": { # Sets the boot disk configuration for the TPU node. # Optional. Boot disk configuration. + "customerEncryptionKey": { # Defines the customer encryption key for disk encryption. # Optional. Customer encryption key for boot disk. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 + }, + }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. "dataDisks": [ # The additional data disks for the Node. @@ -295,6 +300,11 @@

Method Details

}, "acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node. "apiVersion": "A String", # Output only. The API version that created this Node. + "bootDiskConfig": { # Sets the boot disk configuration for the TPU node. # Optional. Boot disk configuration. + "customerEncryptionKey": { # Defines the customer encryption key for disk encryption. # Optional. Customer encryption key for boot disk. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 + }, + }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. "dataDisks": [ # The additional data disks for the Node. @@ -447,6 +457,11 @@

Method Details

}, "acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node. "apiVersion": "A String", # Output only. The API version that created this Node. + "bootDiskConfig": { # Sets the boot disk configuration for the TPU node. # Optional. Boot disk configuration. + "customerEncryptionKey": { # Defines the customer encryption key for disk encryption. # Optional. Customer encryption key for boot disk. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 + }, + }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. "dataDisks": [ # The additional data disks for the Node. @@ -566,6 +581,11 @@

Method Details

}, "acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node. "apiVersion": "A String", # Output only. The API version that created this Node. + "bootDiskConfig": { # Sets the boot disk configuration for the TPU node. # Optional. Boot disk configuration. + "customerEncryptionKey": { # Defines the customer encryption key for disk encryption. # Optional. Customer encryption key for boot disk. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 + }, + }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. "dataDisks": [ # The additional data disks for the Node. diff --git a/docs/dyn/tpu_v2.projects.locations.queuedResources.html b/docs/dyn/tpu_v2.projects.locations.queuedResources.html index 4ad3b748a51..58d66ef61a0 100644 --- a/docs/dyn/tpu_v2.projects.locations.queuedResources.html +++ b/docs/dyn/tpu_v2.projects.locations.queuedResources.html @@ -172,6 +172,11 @@

Method Details

}, "acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node. "apiVersion": "A String", # Output only. The API version that created this Node. + "bootDiskConfig": { # Sets the boot disk configuration for the TPU node. # Optional. Boot disk configuration. + "customerEncryptionKey": { # Defines the customer encryption key for disk encryption. # Optional. Customer encryption key for boot disk. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 + }, + }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. "dataDisks": [ # The additional data disks for the Node. @@ -405,6 +410,11 @@

Method Details

}, "acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node. "apiVersion": "A String", # Output only. The API version that created this Node. + "bootDiskConfig": { # Sets the boot disk configuration for the TPU node. # Optional. Boot disk configuration. + "customerEncryptionKey": { # Defines the customer encryption key for disk encryption. # Optional. Customer encryption key for boot disk. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 + }, + }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. "dataDisks": [ # The additional data disks for the Node. @@ -576,6 +586,11 @@

Method Details

}, "acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node. "apiVersion": "A String", # Output only. The API version that created this Node. + "bootDiskConfig": { # Sets the boot disk configuration for the TPU node. # Optional. Boot disk configuration. + "customerEncryptionKey": { # Defines the customer encryption key for disk encryption. # Optional. Customer encryption key for boot disk. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 + }, + }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. "dataDisks": [ # The additional data disks for the Node. diff --git a/docs/dyn/tpu_v2alpha1.projects.locations.html b/docs/dyn/tpu_v2alpha1.projects.locations.html index d9f118dcbc9..c6206b72ed2 100644 --- a/docs/dyn/tpu_v2alpha1.projects.locations.html +++ b/docs/dyn/tpu_v2alpha1.projects.locations.html @@ -185,7 +185,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/tpu_v2alpha1.projects.locations.nodes.html b/docs/dyn/tpu_v2alpha1.projects.locations.nodes.html index 0473ae82376..0cc1d6c3e90 100644 --- a/docs/dyn/tpu_v2alpha1.projects.locations.nodes.html +++ b/docs/dyn/tpu_v2alpha1.projects.locations.nodes.html @@ -142,6 +142,7 @@

Method Details

"provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops). "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. "sourceImage": "A String", # Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`. + "storagePool": "A String", # Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource. }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. @@ -330,6 +331,7 @@

Method Details

"provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops). "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. "sourceImage": "A String", # Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`. + "storagePool": "A String", # Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource. }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. @@ -499,6 +501,7 @@

Method Details

"provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops). "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. "sourceImage": "A String", # Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`. + "storagePool": "A String", # Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource. }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. @@ -635,6 +638,7 @@

Method Details

"provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops). "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. "sourceImage": "A String", # Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`. + "storagePool": "A String", # Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource. }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. diff --git a/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html b/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html index 5df90148a0a..2460f0ad1a5 100644 --- a/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html +++ b/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html @@ -194,6 +194,7 @@

Method Details

"provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops). "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. "sourceImage": "A String", # Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`. + "storagePool": "A String", # Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource. }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. @@ -453,6 +454,7 @@

Method Details

"provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops). "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. "sourceImage": "A String", # Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`. + "storagePool": "A String", # Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource. }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. @@ -650,6 +652,7 @@

Method Details

"provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops). "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. "sourceImage": "A String", # Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`. + "storagePool": "A String", # Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource. }, "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. "createTime": "A String", # Output only. The time when the node was created. diff --git a/googleapiclient/discovery_cache/documents/tpu.v1.json b/googleapiclient/discovery_cache/documents/tpu.v1.json index e49fb8ce68c..fe014e0b2d4 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -665,7 +665,7 @@ } } }, -"revision": "20250815", +"revision": "20250903", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json index 10cac263833..dd5bc8c430d 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -675,7 +675,7 @@ } } }, -"revision": "20250815", +"revision": "20250903", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v2.json b/googleapiclient/discovery_cache/documents/tpu.v2.json index 7aa3570015f..3abe5976056 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v2.json +++ b/googleapiclient/discovery_cache/documents/tpu.v2.json @@ -172,7 +172,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -893,7 +893,7 @@ } } }, -"revision": "20250815", +"revision": "20250903", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1000,12 +1000,34 @@ }, "type": "object" }, +"BootDiskConfig": { +"description": "Sets the boot disk configuration for the TPU node.", +"id": "BootDiskConfig", +"properties": { +"customerEncryptionKey": { +"$ref": "CustomerEncryptionKey", +"description": "Optional. Customer encryption key for boot disk." +} +}, +"type": "object" +}, "CreatingData": { "description": "Further data for the creating state.", "id": "CreatingData", "properties": {}, "type": "object" }, +"CustomerEncryptionKey": { +"description": "Defines the customer encryption key for disk encryption.", +"id": "CustomerEncryptionKey", +"properties": { +"kmsKeyName": { +"description": "The name of the encryption key that is stored in Google Cloud KMS. For example: \"kmsKeyName\": \"projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: \"kmsKeyName\": \"projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 ", +"type": "string" +} +}, +"type": "object" +}, "DeletingData": { "description": "Further data for the deleting state.", "id": "DeletingData", @@ -1421,6 +1443,10 @@ "readOnly": true, "type": "string" }, +"bootDiskConfig": { +"$ref": "BootDiskConfig", +"description": "Optional. Boot disk configuration." +}, "cidrBlock": { "description": "The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json index 31165713e3e..95db60ae29e 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json @@ -172,7 +172,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1027,7 +1027,7 @@ } } }, -"revision": "20250815", +"revision": "20250903", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1177,6 +1177,10 @@ "sourceImage": { "description": "Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`.", "type": "string" +}, +"storagePool": { +"description": "Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource.", +"type": "string" } }, "type": "object" From b480cc8d99960ec3ce060d4b00d3ab6054cad2e1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 9 Sep 2025 07:09:11 +0000 Subject: [PATCH 27/27] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...roidmanagement_v1.enterprises.devices.html | 8 +- ....projects.instances.materializedViews.html | 34 +- .../classroom_v1.courses.announcements.html | 4 +- docs/dyn/classroom_v1.courses.courseWork.html | 4 +- docs/dyn/cloudbuild_v1.projects.builds.html | 8 +- ...oudbuild_v1.projects.locations.builds.html | 8 +- ...dbuild_v1.projects.locations.triggers.html | 12 +- docs/dyn/cloudbuild_v1.projects.triggers.html | 12 +- .../dyn/cloudbuild_v2.projects.locations.html | 2 +- docs/dyn/cloudlocationfinder_v1.html | 111 ++++ docs/dyn/cloudlocationfinder_v1.projects.html | 91 ++++ ..._v1.projects.locations.cloudLocations.html | 221 ++++++++ ...dlocationfinder_v1.projects.locations.html | 177 +++++++ ...tionfinder_v1alpha.projects.locations.html | 2 +- ...ns.authorizedViewSets.authorizedViews.html | 2 +- ...projects.locations.authorizedViewSets.html | 2 +- ...tcenterinsights_v1.projects.locations.html | 6 +- .../dyn/datafusion_v1.projects.locations.html | 2 +- ...datafusion_v1beta1.projects.locations.html | 2 +- .../deploymentmanager_alpha.deployments.html | 2 +- .../dyn/deploymentmanager_v2.deployments.html | 2 +- .../deploymentmanager_v2beta.deployments.html | 2 +- .../dyn/dialogflow_v2.projects.locations.html | 2 +- .../dyn/dialogflow_v3.projects.locations.html | 2 +- docs/dyn/dns_v1.policies.html | 56 +-- docs/dyn/dns_v1.resourceRecordSets.html | 4 +- docs/dyn/dns_v1beta2.policies.html | 56 +-- docs/dyn/dns_v1beta2.resourceRecordSets.html | 4 +- docs/dyn/firestore_v1.projects.databases.html | 6 +- docs/dyn/firestore_v1.projects.locations.html | 2 +- ...hantapi_accounts_v1.accounts.programs.html | 8 +- ...chantapi_accounts_v1.accounts.regions.html | 4 +- ...api_accounts_v1beta.accounts.programs.html | 8 +- ...migrationcenter_v1.projects.locations.html | 2 +- ...ioncenter_v1alpha1.projects.locations.html | 2 +- docs/dyn/ml_v1.projects.models.html | 10 +- docs/dyn/ml_v1.projects.models.versions.html | 10 +- ...tions.locations.securityProfileGroups.html | 4 + ...anizations.locations.securityProfiles.html | 44 ++ ...v2.projects.locations.jobs.executions.html | 4 +- ...jects.locations.jobs.executions.tasks.html | 4 +- docs/dyn/run_v2.projects.locations.jobs.html | 8 +- .../run_v2.projects.locations.services.html | 8 +- ...projects.locations.services.revisions.html | 4 +- ...run_v2.projects.locations.workerPools.html | 8 +- ...jects.locations.workerPools.revisions.html | 4 +- docs/dyn/sts_v1.v1.html | 4 +- docs/dyn/trafficdirector_v3.discovery.html | 4 +- .../vmmigration_v1.projects.locations.html | 2 +- ...migration_v1alpha1.projects.locations.html | 2 +- .../documents/androidmanagement.v1.json | 4 +- .../documents/backupdr.v1.json | 14 +- .../documents/bigtableadmin.v2.json | 12 +- .../documents/classroom.v1.json | 6 +- .../documents/cloudbuild.v1.json | 4 +- .../documents/cloudbuild.v2.json | 4 +- .../documents/cloudfunctions.v2.json | 6 +- .../documents/cloudfunctions.v2alpha.json | 6 +- .../documents/cloudfunctions.v2beta.json | 6 +- .../documents/cloudlocationfinder.v1.json | 472 ++++++++++++++++++ .../cloudlocationfinder.v1alpha.json | 4 +- .../documents/contactcenterinsights.v1.json | 8 +- .../documents/containeranalysis.v1.json | 4 +- .../documents/containeranalysis.v1alpha1.json | 4 +- .../documents/containeranalysis.v1beta1.json | 4 +- .../documents/datafusion.v1.json | 16 +- .../documents/datafusion.v1beta1.json | 16 +- .../documents/deploymentmanager.alpha.json | 3 +- .../documents/deploymentmanager.v2.json | 3 +- .../documents/deploymentmanager.v2beta.json | 3 +- .../documents/dialogflow.v2.json | 4 +- .../documents/dialogflow.v3.json | 4 +- .../discovery_cache/documents/dns.v1.json | 22 +- .../documents/dns.v1beta2.json | 22 +- .../documents/firestore.v1.json | 10 +- .../discovery_cache/documents/gkehub.v1.json | 8 +- .../documents/gkehub.v1alpha.json | 8 +- .../documents/gkehub.v1beta.json | 8 +- .../discovery_cache/documents/gkehub.v2.json | 8 +- .../documents/gkehub.v2alpha.json | 8 +- .../documents/gkehub.v2beta.json | 8 +- .../documents/groupsmigration.v1.json | 2 +- .../documents/merchantapi.accounts_v1.json | 8 +- .../merchantapi.accounts_v1beta.json | 4 +- .../merchantapi.issueresolution_v1beta.json | 8 +- .../documents/migrationcenter.v1.json | 4 +- .../documents/migrationcenter.v1alpha1.json | 4 +- .../discovery_cache/documents/ml.v1.json | 4 +- .../documents/networksecurity.v1beta1.json | 63 ++- .../documents/retail.v2alpha.json | 8 +- .../discovery_cache/documents/run.v1.json | 4 +- .../discovery_cache/documents/run.v2.json | 6 +- .../discovery_cache/documents/sts.v1.json | 6 +- .../documents/trafficdirector.v3.json | 4 +- .../documents/vmmigration.v1.json | 4 +- .../documents/vmmigration.v1alpha1.json | 4 +- 96 files changed, 1511 insertions(+), 321 deletions(-) create mode 100644 docs/dyn/cloudlocationfinder_v1.html create mode 100644 docs/dyn/cloudlocationfinder_v1.projects.html create mode 100644 docs/dyn/cloudlocationfinder_v1.projects.locations.cloudLocations.html create mode 100644 docs/dyn/cloudlocationfinder_v1.projects.locations.html create mode 100644 googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html index 331de6d9977..681039837c5 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.devices.html +++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html @@ -267,7 +267,7 @@

Method Details

"hardware": "A String", # Name of the hardware. For example, Angler. "manufacturer": "A String", # Manufacturer. For example, Motorola. "model": "A String", # The model of the device. For example, Asus Nexus 7. - "serialNumber": "A String", # The device serial number. + "serialNumber": "A String", # The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId. "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. 3.14, ], @@ -684,7 +684,7 @@

Method Details

"hardware": "A String", # Name of the hardware. For example, Angler. "manufacturer": "A String", # Manufacturer. For example, Motorola. "model": "A String", # The model of the device. For example, Asus Nexus 7. - "serialNumber": "A String", # The device serial number. + "serialNumber": "A String", # The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId. "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. 3.14, ], @@ -969,7 +969,7 @@

Method Details

"hardware": "A String", # Name of the hardware. For example, Angler. "manufacturer": "A String", # Manufacturer. For example, Motorola. "model": "A String", # The model of the device. For example, Asus Nexus 7. - "serialNumber": "A String", # The device serial number. + "serialNumber": "A String", # The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId. "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. 3.14, ], @@ -1236,7 +1236,7 @@

Method Details

"hardware": "A String", # Name of the hardware. For example, Angler. "manufacturer": "A String", # Manufacturer. For example, Motorola. "model": "A String", # The model of the device. For example, Asus Nexus 7. - "serialNumber": "A String", # The device serial number. + "serialNumber": "A String", # The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId. "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. 3.14, ], diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.materializedViews.html b/docs/dyn/bigtableadmin_v2.projects.instances.materializedViews.html index e700092d789..69d9ecf9439 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.materializedViews.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.materializedViews.html @@ -120,10 +120,10 @@

Method Details

The object takes the form of: { # A materialized view object that can be referenced in SQL queries. - "deletionProtection": True or False, # Set to true to make the MaterializedView protected against deletion. - "etag": "A String", # Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. - "name": "A String", # Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` - "query": "A String", # Required. Immutable. The materialized view's select query. + "deletionProtection": True or False, # Set to true to make the MaterializedView protected against deletion. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. + "etag": "A String", # Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. + "name": "A String", # Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. + "query": "A String", # Required. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`. } materializedViewId: string, Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name. @@ -190,10 +190,10 @@

Method Details

An object of the form: { # A materialized view object that can be referenced in SQL queries. - "deletionProtection": True or False, # Set to true to make the MaterializedView protected against deletion. - "etag": "A String", # Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. - "name": "A String", # Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` - "query": "A String", # Required. Immutable. The materialized view's select query. + "deletionProtection": True or False, # Set to true to make the MaterializedView protected against deletion. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. + "etag": "A String", # Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. + "name": "A String", # Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. + "query": "A String", # Required. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`. }
@@ -272,10 +272,10 @@

Method Details

{ # Response message for BigtableInstanceAdmin.ListMaterializedViews. "materializedViews": [ # The list of requested materialized views. { # A materialized view object that can be referenced in SQL queries. - "deletionProtection": True or False, # Set to true to make the MaterializedView protected against deletion. - "etag": "A String", # Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. - "name": "A String", # Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` - "query": "A String", # Required. Immutable. The materialized view's select query. + "deletionProtection": True or False, # Set to true to make the MaterializedView protected against deletion. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. + "etag": "A String", # Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. + "name": "A String", # Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. + "query": "A String", # Required. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`. }, ], "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. @@ -301,15 +301,15 @@

Method Details

Updates a materialized view within an instance.
 
 Args:
-  name: string, Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` (required)
+  name: string, Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A materialized view object that can be referenced in SQL queries.
-  "deletionProtection": True or False, # Set to true to make the MaterializedView protected against deletion.
-  "etag": "A String", # Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
-  "name": "A String", # Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`
-  "query": "A String", # Required. Immutable. The materialized view's select query.
+  "deletionProtection": True or False, # Set to true to make the MaterializedView protected against deletion. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.
+  "etag": "A String", # Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.
+  "name": "A String", # Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.
+  "query": "A String", # Required. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`.
 }
 
   updateMask: string, Optional. The list of fields to update.
diff --git a/docs/dyn/classroom_v1.courses.announcements.html b/docs/dyn/classroom_v1.courses.announcements.html
index d7a64bc8ead..42c0371b10c 100644
--- a/docs/dyn/classroom_v1.courses.announcements.html
+++ b/docs/dyn/classroom_v1.courses.announcements.html
@@ -102,7 +102,7 @@ 

Instance Methods

Retrieves the next page of results.

modifyAssignees(courseId, id, body=None, x__xgafv=None)

-

Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

+

Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees

patch(courseId, id, body=None, updateMask=None, x__xgafv=None)

Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist

@@ -473,7 +473,7 @@

Method Details

modifyAssignees(courseId, id, body=None, x__xgafv=None) -
Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
+  
Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees
 
 Args:
   courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
diff --git a/docs/dyn/classroom_v1.courses.courseWork.html b/docs/dyn/classroom_v1.courses.courseWork.html
index 47c597c5dc3..9bd10ff2ac9 100644
--- a/docs/dyn/classroom_v1.courses.courseWork.html
+++ b/docs/dyn/classroom_v1.courses.courseWork.html
@@ -112,7 +112,7 @@ 

Instance Methods

Retrieves the next page of results.

modifyAssignees(courseId, id, body=None, x__xgafv=None)

-

Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

+

Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees

patch(courseId, id, body=None, updateMask=None, x__xgafv=None)

Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist.

@@ -630,7 +630,7 @@

Method Details

modifyAssignees(courseId, id, body=None, x__xgafv=None) -
Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
+  
Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees
 
 Args:
   courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html
index ccfc3e054ca..c64407a5886 100644
--- a/docs/dyn/cloudbuild_v1.projects.builds.html
+++ b/docs/dyn/cloudbuild_v1.projects.builds.html
@@ -210,7 +210,7 @@ 

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -624,7 +624,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -1069,7 +1069,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -1489,7 +1489,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index 3e230f77a99..e821d41095e 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -209,7 +209,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -623,7 +623,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -1068,7 +1068,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -1488,7 +1488,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index 36a0b388647..f7dbc864b69 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -198,7 +198,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -795,7 +795,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -1420,7 +1420,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -2029,7 +2029,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -2643,7 +2643,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -3242,7 +3242,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index 0fb97c33134..c8f0171c8c7 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -198,7 +198,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -795,7 +795,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -1420,7 +1420,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -2029,7 +2029,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -2644,7 +2644,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], @@ -3241,7 +3241,7 @@

Method Details

], "npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE. { # Npm package to upload to Artifact Registry upon successful completion of all build steps. - "packagePath": "A String", # Path to the package.json. e.g. workspace/path/to/package + "packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified. "repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix. }, ], diff --git a/docs/dyn/cloudbuild_v2.projects.locations.html b/docs/dyn/cloudbuild_v2.projects.locations.html index 61128fb3c0d..8a7e902b525 100644 --- a/docs/dyn/cloudbuild_v2.projects.locations.html +++ b/docs/dyn/cloudbuild_v2.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/cloudlocationfinder_v1.html b/docs/dyn/cloudlocationfinder_v1.html new file mode 100644 index 00000000000..91ddb7c55fd --- /dev/null +++ b/docs/dyn/cloudlocationfinder_v1.html @@ -0,0 +1,111 @@ + + + +

Cloud Location Finder API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudlocationfinder_v1.projects.html b/docs/dyn/cloudlocationfinder_v1.projects.html new file mode 100644 index 00000000000..56e4c361ce3 --- /dev/null +++ b/docs/dyn/cloudlocationfinder_v1.projects.html @@ -0,0 +1,91 @@ + + + +

Cloud Location Finder API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudlocationfinder_v1.projects.locations.cloudLocations.html b/docs/dyn/cloudlocationfinder_v1.projects.locations.cloudLocations.html new file mode 100644 index 00000000000..ca231ee99e0 --- /dev/null +++ b/docs/dyn/cloudlocationfinder_v1.projects.locations.cloudLocations.html @@ -0,0 +1,221 @@ + + + +

Cloud Location Finder API . projects . locations . cloudLocations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Retrieves a resource containing information about a cloud location.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists cloud locations under a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ search(parent, pageSize=None, pageToken=None, query=None, sourceCloudLocation=None, x__xgafv=None)

+

Searches for cloud locations from a given source location.

+

+ search_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Retrieves a resource containing information about a cloud location.
+
+Args:
+  name: string, Required. Name of the resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents resource cloud locations.
+  "carbonFreeEnergyPercentage": 3.14, # Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
+  "cloudLocationType": "A String", # Optional. The type of the cloud location.
+  "cloudProvider": "A String", # Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
+  "containingCloudLocation": "A String", # Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
+  "displayName": "A String", # Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
+  "name": "A String", # Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
+  "territoryCode": "A String", # Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists cloud locations under a given project and location.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. A filter expression that filters resources listed in the response. The expression is in the form of field=value. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION'. Multiple filter queries are space-separated. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code="US"' By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.
+  pageSize: integer, Optional. The maximum number of cloud locations to return per page. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Provide page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' 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:
+
+    { # Message for response to listing cloud locations.
+  "cloudLocations": [ # Output only. List of cloud locations.
+    { # Represents resource cloud locations.
+      "carbonFreeEnergyPercentage": 3.14, # Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
+      "cloudLocationType": "A String", # Optional. The type of the cloud location.
+      "cloudProvider": "A String", # Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
+      "containingCloudLocation": "A String", # Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
+      "displayName": "A String", # Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
+      "name": "A String", # Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
+      "territoryCode": "A String", # Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ search(parent, pageSize=None, pageToken=None, query=None, sourceCloudLocation=None, x__xgafv=None) +
Searches for cloud locations from a given source location.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location} (required)
+  pageSize: integer, Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.
+  query: string, Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements.
+  sourceCloudLocation: string, Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to searching cloud locations.
+  "cloudLocations": [ # Output only. List of cloud locations.
+    { # Represents resource cloud locations.
+      "carbonFreeEnergyPercentage": 3.14, # Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
+      "cloudLocationType": "A String", # Optional. The type of the cloud location.
+      "cloudProvider": "A String", # Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
+      "containingCloudLocation": "A String", # Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
+      "displayName": "A String", # Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
+      "name": "A String", # Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
+      "territoryCode": "A String", # Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.
+}
+
+ +
+ search_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/cloudlocationfinder_v1.projects.locations.html b/docs/dyn/cloudlocationfinder_v1.projects.locations.html new file mode 100644 index 00000000000..23d5ab7d1f4 --- /dev/null +++ b/docs/dyn/cloudlocationfinder_v1.projects.locations.html @@ -0,0 +1,177 @@ + + + +

Cloud Location Finder API . projects . locations

+

Instance Methods

+

+ cloudLocations() +

+

Returns the cloudLocations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about a location.
+
+Args:
+  name: string, Resource name for the location. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a Google Cloud location.
+  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+    "a_key": "A String",
+  },
+  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+
+ +
+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists information about the supported locations for this service.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Locations.ListLocations.
+  "locations": [ # A list of locations that matches the specified filter in the request.
+    { # A resource that represents a Google Cloud location.
+      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+        "a_key": "A String",
+      },
+      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+    },
+  ],
+  "nextPageToken": "A String", # The standard List next-page token.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html b/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html index cf4c6e5cf85..1197d3c3fdd 100644 --- a/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html +++ b/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html @@ -130,7 +130,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html index d29b3469370..79079e2a93f 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html @@ -149,7 +149,7 @@

Method Details

"updateTime": "A String", # Output only. The most recent time at which the authorized view was updated. } - authorizedViewId: string, Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See aip.dev/122#resource-id-segments + authorizedViewId: string, Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html index 006c8a568cc..02b47ea2308 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html @@ -122,7 +122,7 @@

Method Details

"updateTime": "A String", # Output only. Update time. } - authorizedViewSetId: string, Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See aip.dev/122#resource-id-segments + authorizedViewSetId: string, Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index 46e00cb82d8..d54f686d9b0 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -402,7 +402,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the settings was created. "languageCode": "A String", # A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here. "name": "A String", # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings - "pubsubNotificationSettings": { # A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} + "pubsubNotificationSettings": { # A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. * "update-or-analyze-conversation": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} "a_key": "A String", }, "redactionConfig": { # DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. # Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. @@ -642,7 +642,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the settings was created. "languageCode": "A String", # A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here. "name": "A String", # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings - "pubsubNotificationSettings": { # A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} + "pubsubNotificationSettings": { # A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. * "update-or-analyze-conversation": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} "a_key": "A String", }, "redactionConfig": { # DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. # Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. @@ -702,7 +702,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the settings was created. "languageCode": "A String", # A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here. "name": "A String", # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings - "pubsubNotificationSettings": { # A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} + "pubsubNotificationSettings": { # A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. * "update-or-analyze-conversation": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} "a_key": "A String", }, "redactionConfig": { # DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. # Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. diff --git a/docs/dyn/datafusion_v1.projects.locations.html b/docs/dyn/datafusion_v1.projects.locations.html index 15ab08f8549..a4a8a08a2f8 100644 --- a/docs/dyn/datafusion_v1.projects.locations.html +++ b/docs/dyn/datafusion_v1.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/datafusion_v1beta1.projects.locations.html b/docs/dyn/datafusion_v1beta1.projects.locations.html index ae2f87c89ef..67fbfd58ded 100644 --- a/docs/dyn/datafusion_v1beta1.projects.locations.html +++ b/docs/dyn/datafusion_v1beta1.projects.locations.html @@ -143,7 +143,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/deploymentmanager_alpha.deployments.html b/docs/dyn/deploymentmanager_alpha.deployments.html index 19d5682f0fe..48dd93fcac0 100644 --- a/docs/dyn/deploymentmanager_alpha.deployments.html +++ b/docs/dyn/deploymentmanager_alpha.deployments.html @@ -1640,7 +1640,7 @@

Method Details

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, - "updateMask": "A String", + "updateMask": "A String", # Update mask for the policy. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/deploymentmanager_v2.deployments.html b/docs/dyn/deploymentmanager_v2.deployments.html index 919d038f753..e90b0637b10 100644 --- a/docs/dyn/deploymentmanager_v2.deployments.html +++ b/docs/dyn/deploymentmanager_v2.deployments.html @@ -1534,7 +1534,7 @@

Method Details

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, - "updateMask": "A String", + "updateMask": "A String", # Update mask for the policy. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/deploymentmanager_v2beta.deployments.html b/docs/dyn/deploymentmanager_v2beta.deployments.html index e24eb674c9b..f8f1350aae1 100644 --- a/docs/dyn/deploymentmanager_v2beta.deployments.html +++ b/docs/dyn/deploymentmanager_v2beta.deployments.html @@ -1536,7 +1536,7 @@

Method Details

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). }, - "updateMask": "A String", + "updateMask": "A String", # Update mask for the policy. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2.projects.locations.html b/docs/dyn/dialogflow_v2.projects.locations.html index 4b2df8ae12e..51005c158c0 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.html @@ -272,7 +272,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/dialogflow_v3.projects.locations.html b/docs/dyn/dialogflow_v3.projects.locations.html index a9bed8eca5f..0ce5e9d198c 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.html +++ b/docs/dyn/dialogflow_v3.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/dns_v1.policies.html b/docs/dyn/dns_v1.policies.html index bb9789dcdbb..14c279acf97 100644 --- a/docs/dyn/dns_v1.policies.html +++ b/docs/dyn/dns_v1.policies.html @@ -79,25 +79,25 @@

Instance Methods

Close httplib2 connections.

create(project, body=None, clientOperationId=None, x__xgafv=None)

-

Creates a new Policy.

+

Creates a new policy.

delete(project, policy, clientOperationId=None, x__xgafv=None)

-

Deletes a previously created Policy. Fails if the policy is still being referenced by a network.

+

Deletes a previously created policy. Fails if the policy is still being referenced by a network.

get(project, policy, clientOperationId=None, x__xgafv=None)

-

Fetches the representation of an existing Policy.

+

Fetches the representation of an existing policy.

list(project, maxResults=None, pageToken=None, x__xgafv=None)

-

Enumerates all Policies associated with a project.

+

Enumerates all policies associated with a project.

list_next()

Retrieves the next page of results.

patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)

-

Applies a partial update to an existing Policy.

+

Applies a partial update to an existing policy.

update(project, policy, body=None, clientOperationId=None, x__xgafv=None)

-

Updates an existing Policy.

+

Updates an existing policy.

Method Details

close() @@ -106,7 +106,7 @@

Method Details

create(project, body=None, clientOperationId=None, x__xgafv=None) -
Creates a new Policy.
+  
Creates a new policy.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -126,10 +126,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -168,10 +168,10 @@

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -191,7 +191,7 @@

Method Details

delete(project, policy, clientOperationId=None, x__xgafv=None) -
Deletes a previously created Policy. Fails if the policy is still being referenced by a network.
+  
Deletes a previously created policy. Fails if the policy is still being referenced by a network.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -206,7 +206,7 @@ 

Method Details

get(project, policy, clientOperationId=None, x__xgafv=None) -
Fetches the representation of an existing Policy.
+  
Fetches the representation of an existing policy.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -233,10 +233,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -256,7 +256,7 @@

Method Details

list(project, maxResults=None, pageToken=None, x__xgafv=None) -
Enumerates all Policies associated with a project.
+  
Enumerates all policies associated with a project.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -287,10 +287,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -326,7 +326,7 @@

Method Details

patch(project, policy, body=None, clientOperationId=None, x__xgafv=None) -
Applies a partial update to an existing Policy.
+  
Applies a partial update to an existing policy.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -347,10 +347,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -390,10 +390,10 @@

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -414,7 +414,7 @@

Method Details

update(project, policy, body=None, clientOperationId=None, x__xgafv=None) -
Updates an existing Policy.
+  
Updates an existing policy.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -435,10 +435,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -478,10 +478,10 @@

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, diff --git a/docs/dyn/dns_v1.resourceRecordSets.html b/docs/dyn/dns_v1.resourceRecordSets.html index 31041ac3086..92aefaab9bb 100644 --- a/docs/dyn/dns_v1.resourceRecordSets.html +++ b/docs/dyn/dns_v1.resourceRecordSets.html @@ -578,9 +578,9 @@

Method Details

project: string, Identifies the project addressed by this request. (required) managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. - name: string, Restricts the list to return only records with this fully qualified domain name. + name: string, Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field. pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. - type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present. + type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present. Mutually exclusive with the {@code filter} field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dns_v1beta2.policies.html b/docs/dyn/dns_v1beta2.policies.html index 1c177ebb121..2518f700413 100644 --- a/docs/dyn/dns_v1beta2.policies.html +++ b/docs/dyn/dns_v1beta2.policies.html @@ -79,25 +79,25 @@

Instance Methods

Close httplib2 connections.

create(project, body=None, clientOperationId=None, x__xgafv=None)

-

Creates a new Policy.

+

Creates a new policy.

delete(project, policy, clientOperationId=None, x__xgafv=None)

-

Deletes a previously created Policy. Fails if the policy is still being referenced by a network.

+

Deletes a previously created policy. Fails if the policy is still being referenced by a network.

get(project, policy, clientOperationId=None, x__xgafv=None)

-

Fetches the representation of an existing Policy.

+

Fetches the representation of an existing policy.

list(project, maxResults=None, pageToken=None, x__xgafv=None)

-

Enumerates all Policies associated with a project.

+

Enumerates all policies associated with a project.

list_next()

Retrieves the next page of results.

patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)

-

Applies a partial update to an existing Policy.

+

Applies a partial update to an existing policy.

update(project, policy, body=None, clientOperationId=None, x__xgafv=None)

-

Updates an existing Policy.

+

Updates an existing policy.

Method Details

close() @@ -106,7 +106,7 @@

Method Details

create(project, body=None, clientOperationId=None, x__xgafv=None) -
Creates a new Policy.
+  
Creates a new policy.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -126,10 +126,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -168,10 +168,10 @@

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -191,7 +191,7 @@

Method Details

delete(project, policy, clientOperationId=None, x__xgafv=None) -
Deletes a previously created Policy. Fails if the policy is still being referenced by a network.
+  
Deletes a previously created policy. Fails if the policy is still being referenced by a network.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -206,7 +206,7 @@ 

Method Details

get(project, policy, clientOperationId=None, x__xgafv=None) -
Fetches the representation of an existing Policy.
+  
Fetches the representation of an existing policy.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -233,10 +233,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -256,7 +256,7 @@

Method Details

list(project, maxResults=None, pageToken=None, x__xgafv=None) -
Enumerates all Policies associated with a project.
+  
Enumerates all policies associated with a project.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -287,10 +287,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -326,7 +326,7 @@

Method Details

patch(project, policy, body=None, clientOperationId=None, x__xgafv=None) -
Applies a partial update to an existing Policy.
+  
Applies a partial update to an existing policy.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -347,10 +347,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -390,10 +390,10 @@

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -414,7 +414,7 @@

Method Details

update(project, policy, body=None, clientOperationId=None, x__xgafv=None) -
Updates an existing Policy.
+  
Updates an existing policy.
 
 Args:
   project: string, Identifies the project addressed by this request. (required)
@@ -435,10 +435,10 @@ 

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, @@ -478,10 +478,10 @@

Method Details

], }, "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. - "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this Policy. + "dns64Config": { # DNS64 policies # Configurations related to DNS64 for this policy. "kind": "dns#policyDns64Config", "scope": { # The scope to which DNS64 config will be applied to. - "allQueries": True or False, # Controls whether DNS64 is enabled globally at the network level. + "allQueries": True or False, # Controls whether DNS64 is enabled globally for all networks bound to the policy. "kind": "dns#policyDns64ConfigScope", }, }, diff --git a/docs/dyn/dns_v1beta2.resourceRecordSets.html b/docs/dyn/dns_v1beta2.resourceRecordSets.html index 33774a27825..2613496da93 100644 --- a/docs/dyn/dns_v1beta2.resourceRecordSets.html +++ b/docs/dyn/dns_v1beta2.resourceRecordSets.html @@ -768,9 +768,9 @@

Method Details

project: string, Identifies the project addressed by this request. (required) managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. - name: string, Restricts the list to return only records with this fully qualified domain name. + name: string, Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field. pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. - type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present. + type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present. Mutually exclusive with the {@code filter} field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/firestore_v1.projects.databases.html b/docs/dyn/firestore_v1.projects.databases.html index 1c0d2ccd0a4..25ed0422728 100644 --- a/docs/dyn/firestore_v1.projects.databases.html +++ b/docs/dyn/firestore_v1.projects.databases.html @@ -190,7 +190,7 @@

Method Details

The object takes the form of: { # The request message for FirestoreAdmin.CloneDatabase. - "databaseId": "A String", # Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid. + "databaseId": "A String", # Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid if the database is Standard edition. "encryptionConfig": { # Encryption configuration for a new database being created from another source. The source could be a Backup . # Optional. Encryption configuration for the cloned database. If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption. "customerManagedEncryption": { # The configuration options for using CMEK (Customer Managed Encryption Key) encryption. # Use Customer Managed Encryption Keys (CMEK) for encryption. "kmsKeyName": "A String", # Required. Only keys in the same location as the database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. @@ -289,7 +289,7 @@

Method Details

"versionRetentionPeriod": "A String", # Output only. The period during which past versions of data are retained in the database. Any read or query can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. } - databaseId: string, Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid. + databaseId: string, Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid if the database is Standard edition. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -648,7 +648,7 @@

Method Details

{ # The request message for FirestoreAdmin.RestoreDatabase. "backup": "A String", # Required. Backup to restore from. Must be from the same project as the parent. The restored database will be created in the same location as the source backup. Format is: `projects/{project_id}/locations/{location}/backups/{backup}` - "databaseId": "A String", # Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid. + "databaseId": "A String", # Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid if the database is Standard edition. "encryptionConfig": { # Encryption configuration for a new database being created from another source. The source could be a Backup . # Optional. Encryption configuration for the restored database. If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption. "customerManagedEncryption": { # The configuration options for using CMEK (Customer Managed Encryption Key) encryption. # Use Customer Managed Encryption Keys (CMEK) for encryption. "kmsKeyName": "A String", # Required. Only keys in the same location as the database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. diff --git a/docs/dyn/firestore_v1.projects.locations.html b/docs/dyn/firestore_v1.projects.locations.html index e223736efde..90230bdeb9a 100644 --- a/docs/dyn/firestore_v1.projects.locations.html +++ b/docs/dyn/firestore_v1.projects.locations.html @@ -130,7 +130,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.programs.html b/docs/dyn/merchantapi_accounts_v1.accounts.programs.html index dc9994479ca..5422a831867 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.programs.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.programs.html @@ -123,7 +123,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -162,7 +162,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -195,7 +195,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -233,7 +233,7 @@

Method Details

{ # Response message for the ListPrograms method. "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "programs": [ # The programs for the given account. - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.regions.html b/docs/dyn/merchantapi_accounts_v1.accounts.regions.html index acd7de2b80a..72351a95ab5 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.regions.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.regions.html @@ -182,12 +182,12 @@

Method Details

Deletes multiple regions by name from your Merchant Center account. Executing this method requires admin access.
 
 Args:
-  parent: string, Required. The account to create a region for. Format: `accounts/{account}` (required)
+  parent: string, Required. The account to delete one or more regions from. Format: `accounts/{account}` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for the `BatchDeleteRegions` method.
-  "requests": [ # Required. The names of the regions to delete. A maximum of 1000 regions can be deleted in a batch.
+  "requests": [ # Required. The names of the regions to delete. A maximum of 100 regions can be deleted in a batch.
     { # Request message for the `DeleteRegion` method.
       "name": "A String", # Required. The name of the region to delete. Format: `accounts/{account}/regions/{region}`
     },
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html
index 82be62c4919..a683d6832ec 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html
@@ -123,7 +123,7 @@ 

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -162,7 +162,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -195,7 +195,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -233,7 +233,7 @@

Method Details

{ # Response message for the ListPrograms method. "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "programs": [ # The programs for the given account. - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], diff --git a/docs/dyn/migrationcenter_v1.projects.locations.html b/docs/dyn/migrationcenter_v1.projects.locations.html index 634c3d54e0d..888a9f8ab5a 100644 --- a/docs/dyn/migrationcenter_v1.projects.locations.html +++ b/docs/dyn/migrationcenter_v1.projects.locations.html @@ -197,7 +197,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.html index 9f96ea438be..09033c2535e 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.html @@ -203,7 +203,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/ml_v1.projects.models.html b/docs/dyn/ml_v1.projects.models.html index 7b959030c8b..273bce57936 100644 --- a/docs/dyn/ml_v1.projects.models.html +++ b/docs/dyn/ml_v1.projects.models.html @@ -195,7 +195,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. @@ -298,7 +298,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. @@ -443,7 +443,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. @@ -606,7 +606,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. @@ -728,7 +728,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. diff --git a/docs/dyn/ml_v1.projects.models.versions.html b/docs/dyn/ml_v1.projects.models.versions.html index 1e37b2af4d0..d4f111ae979 100644 --- a/docs/dyn/ml_v1.projects.models.versions.html +++ b/docs/dyn/ml_v1.projects.models.versions.html @@ -183,7 +183,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. @@ -343,7 +343,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. @@ -446,7 +446,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. @@ -554,7 +554,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. @@ -686,7 +686,7 @@

Method Details

"predictionClass": "A String", # Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). "pythonVersion": "A String", # Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). "requestLoggingConfig": { # Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. # Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. - "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE + "bigqueryTableName": "A String", # Required. Fully qualified BigQuery table name in the following format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE "samplingPercentage": 3.14, # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For example, if you want to log 10% of requests, enter `0.1`. The sampling window is the lifetime of the model version. Defaults to 0. }, "routes": { # Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. # Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values. diff --git a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html index 78db7f95d07..a830295a02a 100644 --- a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html @@ -123,6 +123,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`. "threatPreventionProfile": "A String", # Optional. Reference to a SecurityProfile with the ThreatPrevention configuration. "updateTime": "A String", # Output only. Last resource update timestamp. + "urlFilteringProfile": "A String", # Optional. Reference to a SecurityProfile with the UrlFiltering configuration. } securityProfileGroupId: string, Required. Short name of the SecurityProfileGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "security_profile_group1". @@ -218,6 +219,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`. "threatPreventionProfile": "A String", # Optional. Reference to a SecurityProfile with the ThreatPrevention configuration. "updateTime": "A String", # Output only. Last resource update timestamp. + "urlFilteringProfile": "A String", # Optional. Reference to a SecurityProfile with the UrlFiltering configuration. }
@@ -253,6 +255,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`. "threatPreventionProfile": "A String", # Optional. Reference to a SecurityProfile with the ThreatPrevention configuration. "updateTime": "A String", # Output only. Last resource update timestamp. + "urlFilteringProfile": "A String", # Optional. Reference to a SecurityProfile with the UrlFiltering configuration. }, ], }
@@ -294,6 +297,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`. "threatPreventionProfile": "A String", # Optional. Reference to a SecurityProfile with the ThreatPrevention configuration. "updateTime": "A String", # Output only. Last resource update timestamp. + "urlFilteringProfile": "A String", # Optional. Reference to a SecurityProfile with the UrlFiltering configuration. } updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the SecurityProfileGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. diff --git a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html index feee2e402a7..3b5bf35717c 100644 --- a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html @@ -147,6 +147,17 @@

Method Details

}, "type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures. "updateTime": "A String", # Output only. Last resource update timestamp. + "urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the SecurityProfile. + "urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match. + { # A URL filter defines an action to take for some URL match. + "filteringAction": "A String", # Required. The action taken when this filter is applied. + "priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile. + "urls": [ # Required. The list of strings that a URL must match with for this filter to be applied. + "A String", + ], + }, + ], + }, } securityProfileId: string, Required. Short name of the SecurityProfile resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "security_profile1". @@ -266,6 +277,17 @@

Method Details

}, "type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures. "updateTime": "A String", # Output only. Last resource update timestamp. + "urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the SecurityProfile. + "urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match. + { # A URL filter defines an action to take for some URL match. + "filteringAction": "A String", # Required. The action taken when this filter is applied. + "priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile. + "urls": [ # Required. The list of strings that a URL must match with for this filter to be applied. + "A String", + ], + }, + ], + }, }
@@ -325,6 +347,17 @@

Method Details

}, "type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures. "updateTime": "A String", # Output only. Last resource update timestamp. + "urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the SecurityProfile. + "urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match. + { # A URL filter defines an action to take for some URL match. + "filteringAction": "A String", # Required. The action taken when this filter is applied. + "priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile. + "urls": [ # Required. The list of strings that a URL must match with for this filter to be applied. + "A String", + ], + }, + ], + }, }, ], }
@@ -390,6 +423,17 @@

Method Details

}, "type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures. "updateTime": "A String", # Output only. Last resource update timestamp. + "urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the SecurityProfile. + "urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match. + { # A URL filter defines an action to take for some URL match. + "filteringAction": "A String", # Required. The action taken when this filter is applied. + "priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile. + "urls": [ # Required. The list of strings that a URL must match with for this filter to be applied. + "A String", + ], + }, + ], + }, } updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the SecurityProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html index ccd44ae12fd..de5c6f4f433 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html @@ -412,7 +412,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -637,7 +637,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. 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 15a5e2d02ac..9016e89aae9 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -291,7 +291,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -523,7 +523,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index 3c8f003805c..748ef751ca8 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -319,7 +319,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -633,7 +633,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -933,7 +933,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -1192,7 +1192,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 90dcc9b304e..3912e0da706 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -350,7 +350,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -719,7 +719,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -1075,7 +1075,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -1388,7 +1388,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index 45b8250c0d5..ec59b5c624a 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -366,7 +366,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -594,7 +594,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.html b/docs/dyn/run_v2.projects.locations.workerPools.html index 25ba9c087b9..e63bfdf5eeb 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.html @@ -329,7 +329,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -655,7 +655,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -968,7 +968,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -1238,7 +1238,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html index 3b27654ca65..7c8d47a1d98 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html @@ -327,7 +327,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. @@ -555,7 +555,7 @@

Method Details

}, "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. - "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. + "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "path": "A String", # Required. The relative path of the secret in the container. diff --git a/docs/dyn/sts_v1.v1.html b/docs/dyn/sts_v1.v1.html index 0dd2f4c2b50..a82ef0e635e 100644 --- a/docs/dyn/sts_v1.v1.html +++ b/docs/dyn/sts_v1.v1.html @@ -100,8 +100,8 @@

Method Details

"options": "A String", # A set of features that Security Token Service supports, in addition to the standard OAuth 2.0 token exchange, formatted as a serialized JSON object of Options. The size of the parameter value must not exceed 4 * 1024 * 1024 characters (4 MB). "requestedTokenType": "A String", # Required. An identifier for the type of requested security token. Can be `urn:ietf:params:oauth:token-type:access_token` or `urn:ietf:params:oauth:token-type:access_boundary_intermediary_token`. "scope": "A String", # The OAuth 2.0 scopes to include on the resulting access token, formatted as a list of space-delimited, case-sensitive strings; for example, `https://www.googleapis.com/auth/cloud-platform`. Required when exchanging an external credential for a Google access token. For a list of OAuth 2.0 scopes, see [OAuth 2.0 Scopes for Google APIs](https://developers.google.com/identity/protocols/oauth2/scopes). - "subjectToken": "A String", # Required. The input token. This token is either an external credential issued by a workload identity pool provider, or a short-lived access token issued by Google. If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523](https://tools.ietf.org/html/rfc7523), and the `subject_token_type` must be either `urn:ietf:params:oauth:token-type:jwt` or `urn:ietf:params:oauth:token-type:id_token`. The following headers are required: - `kid`: The identifier of the signing key securing the JWT. - `alg`: The cryptographic algorithm securing the JWT. Must be `RS256` or `ES256`. The following payload fields are required. For more information, see [RFC 7523, Section 3](https://tools.ietf.org/html/rfc7523#section-3): - `iss`: The issuer of the token. The issuer must provide a discovery document at the URL `/.well-known/openid-configuration`, where `` is the value of this field. The document must be formatted according to section 4.2 of the [OIDC 1.0 Discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). - `iat`: The issue time, in seconds, since the Unix epoch. Must be in the past. - `exp`: The expiration time, in seconds, since the Unix epoch. Must be less than 48 hours after `iat`. Shorter expiration times are more secure. If possible, we recommend setting an expiration time less than 6 hours. - `sub`: The identity asserted in the JWT. - `aud`: For workload identity pools, this must be a value specified in the allowed audiences for the workload identity pool provider, or one of the audiences allowed by default if no audiences were specified. See https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers#oidc. For workforce pools, this must match the client ID specified in the provider configuration. See https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools.providers#oidc. Example header: ``` { "alg": "RS256", "kid": "us-east-11" } ``` Example payload: ``` { "iss": "https://accounts.google.com", "iat": 1517963104, "exp": 1517966704, "aud": "//iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/providers/my-provider", "sub": "113475438248934895348", "my_claims": { "additional_claim": "value" } } ``` If `subject_token` is for AWS, it must be a serialized `GetCallerIdentity` token. This token contains the same information as a request to the AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity) method, as well as the AWS [signature](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-type:aws4_request`. The following parameters are required: - `url`: The URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints are also supported. - `method`: The HTTP request method: `POST`. - `headers`: The HTTP request headers, which must include: - `Authorization`: The request signature. - `x-amz-date`: The time you will send the request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date) string. This value is typically set to the current time and is used to help prevent replay attacks. - `host`: The hostname of the `url` field; for example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full, canonical resource name of the workload identity pool provider, with or without an `https:` prefix. To help ensure data integrity, we recommend including this header in the `SignedHeaders` field of the signed request. For example: //iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ If you are using temporary security credentials provided by AWS, you must also include the header `x-amz-security-token`, with the value set to the session token. The following example shows a `GetCallerIdentity` token: ``` { "headers": [ {"key": "x-amz-date", "value": "20200815T015049Z"}, {"key": "Authorization", "value": "AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$signature"}, {"key": "x-goog-cloud-target-resource", "value": "//iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/"}, {"key": "host", "value": "sts.amazonaws.com"} . ], "method": "POST", "url": "https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15" } ``` If the token is a SAML 2.0 assertion, it must use the format defined in [the SAML 2.0 spec](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.pdf), and the `subject_token_type` must be `urn:ietf:params:oauth:token-type:saml2`. See [Verification of external credentials](https://cloud.google.com/iam/docs/using-workload-identity-federation#verification_of_external_credentials) for details on how SAML 2.0 assertions are validated during token exchanges. You can also use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. In this case, set `subject_token_type` to `urn:ietf:params:oauth:token-type:access_token`. If an access token already contains security attributes, you cannot apply additional security attributes. - "subjectTokenType": "A String", # Required. An identifier that indicates the type of the security token in the `subject_token` parameter. Supported values are `urn:ietf:params:oauth:token-type:jwt`, `urn:ietf:params:oauth:token-type:id_token`, `urn:ietf:params:aws:token-type:aws4_request`, `urn:ietf:params:oauth:token-type:access_token`, and `urn:ietf:params:oauth:token-type:saml2`. + "subjectToken": "A String", # Required. The input token. This token is either an external credential issued by a workload identity pool provider, or a short-lived access token issued by Google. If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523](https://tools.ietf.org/html/rfc7523), and the `subject_token_type` must be either `urn:ietf:params:oauth:token-type:jwt` or `urn:ietf:params:oauth:token-type:id_token`. The following headers are required: - `kid`: The identifier of the signing key securing the JWT. - `alg`: The cryptographic algorithm securing the JWT. Must be `RS256` or `ES256`. The following payload fields are required. For more information, see [RFC 7523, Section 3](https://tools.ietf.org/html/rfc7523#section-3): - `iss`: The issuer of the token. The issuer must provide a discovery document at the URL `/.well-known/openid-configuration`, where `` is the value of this field. The document must be formatted according to section 4.2 of the [OIDC 1.0 Discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). - `iat`: The issue time, in seconds, since the Unix epoch. Must be in the past. - `exp`: The expiration time, in seconds, since the Unix epoch. Must be less than 48 hours after `iat`. Shorter expiration times are more secure. If possible, we recommend setting an expiration time less than 6 hours. - `sub`: The identity asserted in the JWT. - `aud`: For workload identity pools, this must be a value specified in the allowed audiences for the workload identity pool provider, or one of the audiences allowed by default if no audiences were specified. See https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers#oidc. For workforce pools, this must match the client ID specified in the provider configuration. See https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools.providers#oidc. Example header: ``` { "alg": "RS256", "kid": "us-east-11" } ``` Example payload: ``` { "iss": "https://accounts.google.com", "iat": 1517963104, "exp": 1517966704, "aud": "//iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/providers/my-provider", "sub": "113475438248934895348", "my_claims": { "additional_claim": "value" } } ``` If `subject_token` is for AWS, it must be a serialized `GetCallerIdentity` token. This token contains the same information as a request to the AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity) method, as well as the AWS [signature](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-type:aws4_request`. The following parameters are required: - `url`: The URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints are also supported. - `method`: The HTTP request method: `POST`. - `headers`: The HTTP request headers, which must include: - `Authorization`: The request signature. - `x-amz-date`: The time you will send the request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date) string. This value is typically set to the current time and is used to help prevent replay attacks. - `host`: The hostname of the `url` field; for example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full, canonical resource name of the workload identity pool provider, with or without an `https:` prefix. To help ensure data integrity, we recommend including this header in the `SignedHeaders` field of the signed request. For example: //iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ If you are using temporary security credentials provided by AWS, you must also include the header `x-amz-security-token`, with the value set to the session token. The following example shows a `GetCallerIdentity` token: ``` { "headers": [ {"key": "x-amz-date", "value": "20200815T015049Z"}, {"key": "Authorization", "value": "AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$signature"}, {"key": "x-goog-cloud-target-resource", "value": "//iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/"}, {"key": "host", "value": "sts.amazonaws.com"} . ], "method": "POST", "url": "https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15" } ``` If the token is a SAML 2.0 assertion, it must use the format defined in [the SAML 2.0 spec](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.pdf), and the `subject_token_type` must be `urn:ietf:params:oauth:token-type:saml2`. See [Verification of external credentials](https://cloud.google.com/iam/docs/using-workload-identity-federation#verification_of_external_credentials) for details on how SAML 2.0 assertions are validated during token exchanges. You can also use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. In this case, set `subject_token_type` to `urn:ietf:params:oauth:token-type:access_token`. If an access token already contains security attributes, you cannot apply additional security attributes. If the request is for X.509 certificate-based authentication, the `subject_token` must be a JSON-formatted list of X.509 certificates in DER format, as defined in [RFC 7515](https://www.rfc-editor.org/rfc/rfc7515#section-4.1.6). `subject_token_type` must be `urn:ietf:params:oauth:token-type:mtls`. The following example shows a JSON-formatted list of X.509 certificate in DER format: ``` [\"MIIEYDCCA0i...\", \"MCIFFGAGTT0...\"] ``` + "subjectTokenType": "A String", # Required. An identifier that indicates the type of the security token in the `subject_token` parameter. Supported values are `urn:ietf:params:oauth:token-type:jwt`, `urn:ietf:params:oauth:token-type:id_token`, `urn:ietf:params:aws:token-type:aws4_request`, `urn:ietf:params:oauth:token-type:access_token`, `urn:ietf:params:oauth:token-type:mtls`, and `urn:ietf:params:oauth:token-type:saml2`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/trafficdirector_v3.discovery.html b/docs/dyn/trafficdirector_v3.discovery.html index 3693b602692..af6dae18e8f 100644 --- a/docs/dyn/trafficdirector_v3.discovery.html +++ b/docs/dyn/trafficdirector_v3.discovery.html @@ -139,7 +139,7 @@

Method Details

"address": "A String", # The address for this socket. :ref:`Listeners ` will bind to the address. An empty address is not allowed. Specify ``0.0.0.0`` or ``::`` to bind to any address. [#comment:TODO(zuercher) reinstate when implemented: It is possible to distinguish a Listener address via the prefix/suffix matching in :ref:`FilterChainMatch `.] When used within an upstream :ref:`BindConfig `, the address controls the source address of outbound connections. For :ref:`clusters `, the cluster type determines whether the address must be an IP (``STATIC`` or ``EDS`` clusters) or a hostname resolved by DNS (``STRICT_DNS`` or ``LOGICAL_DNS`` clusters). Address resolution can be customized via :ref:`resolver_name `. "ipv4Compat": True or False, # When binding to an IPv6 address above, this enables `IPv4 compatibility `_. Binding to ``::`` will allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into IPv6 space as ``::FFFF:``. "namedPort": "A String", # This is only valid if :ref:`resolver_name ` is specified below and the named resolver is capable of named port resolution. - "networkNamespaceFilepath": "A String", # Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. note:: Currently only used for Listener sockets. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect. + "networkNamespaceFilepath": "A String", # Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect. "portValue": 42, "protocol": "A String", "resolverName": "A String", # The name of the custom resolver. This must have been registered with Envoy. If this is empty, a context dependent default applies. If the address is a concrete IP address, no resolution will occur. If address is a hostname this should be set for resolution other than DNS. Specifying a custom resolver with ``STRICT_DNS`` or ``LOGICAL_DNS`` will generate an error at runtime. @@ -323,7 +323,7 @@

Method Details

"address": "A String", # The address for this socket. :ref:`Listeners ` will bind to the address. An empty address is not allowed. Specify ``0.0.0.0`` or ``::`` to bind to any address. [#comment:TODO(zuercher) reinstate when implemented: It is possible to distinguish a Listener address via the prefix/suffix matching in :ref:`FilterChainMatch `.] When used within an upstream :ref:`BindConfig `, the address controls the source address of outbound connections. For :ref:`clusters `, the cluster type determines whether the address must be an IP (``STATIC`` or ``EDS`` clusters) or a hostname resolved by DNS (``STRICT_DNS`` or ``LOGICAL_DNS`` clusters). Address resolution can be customized via :ref:`resolver_name `. "ipv4Compat": True or False, # When binding to an IPv6 address above, this enables `IPv4 compatibility `_. Binding to ``::`` will allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into IPv6 space as ``::FFFF:``. "namedPort": "A String", # This is only valid if :ref:`resolver_name ` is specified below and the named resolver is capable of named port resolution. - "networkNamespaceFilepath": "A String", # Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. note:: Currently only used for Listener sockets. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect. + "networkNamespaceFilepath": "A String", # Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect. "portValue": 42, "protocol": "A String", "resolverName": "A String", # The name of the custom resolver. This must have been registered with Envoy. If this is empty, a context dependent default applies. If the address is a concrete IP address, no resolution will occur. If address is a hostname this should be set for resolution other than DNS. Specifying a custom resolver with ``STRICT_DNS`` or ``LOGICAL_DNS`` will generate an error at runtime. diff --git a/docs/dyn/vmmigration_v1.projects.locations.html b/docs/dyn/vmmigration_v1.projects.locations.html index ca958f0b954..dd9c3a04f35 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.html +++ b/docs/dyn/vmmigration_v1.projects.locations.html @@ -150,7 +150,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.html index be9c8fcde5e..dfe2d45dc11 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.html @@ -150,7 +150,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 45625eb0755..a80e6b798a3 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1260,7 +1260,7 @@ } } }, -"revision": "20250829", +"revision": "20250902", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -4161,7 +4161,7 @@ false "type": "string" }, "serialNumber": { -"description": "The device serial number.", +"description": "The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId.", "type": "string" }, "skinShutdownTemperatures": { diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index b494d95975a..32d0e788c17 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -2117,7 +2117,7 @@ } } }, -"revision": "20250825", +"revision": "20250830", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -5030,11 +5030,13 @@ "enum": [ "FEATURE_UNSPECIFIED", "MANAGEMENT_SERVER", -"COMPUTE_INSTANCE" +"COMPUTE_INSTANCE", +"PROTECTION_SUMMARY" ], "enumDescriptions": [ "", "", +"", "" ], "type": "string" @@ -5583,12 +5585,16 @@ "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CLOUD_SQL_INSTANCE", -"COMPUTE_ENGINE_VM" +"COMPUTE_ENGINE_VM", +"COMPUTE_ENGINE_DISK", +"COMPUTE_ENGINE_REGIONAL_DISK" ], "enumDescriptions": [ "Resource type not set.", "Cloud SQL instance.", -"Compute Engine VM." +"Compute Engine VM.", +"Compute Engine Disk.", +"Compute Engine Regional Disk." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 3b3ca9d38a6..8033a6a605d 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -1786,7 +1786,7 @@ ], "parameters": { "name": { -"description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`", +"description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.", "location": "path", "pattern": "^projects/[^/]+/instances/[^/]+/materializedViews/[^/]+$", "required": true, @@ -3077,7 +3077,7 @@ } } }, -"revision": "20250821", +"revision": "20250828", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -4941,19 +4941,19 @@ "id": "MaterializedView", "properties": { "deletionProtection": { -"description": "Set to true to make the MaterializedView protected against deletion.", +"description": "Set to true to make the MaterializedView protected against deletion. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.", "type": "boolean" }, "etag": { -"description": "Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.", +"description": "Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.", "type": "string" }, "name": { -"description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`", +"description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.", "type": "string" }, "query": { -"description": "Required. Immutable. The materialized view's select query.", +"description": "Required. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index af757d82635..c6f0718610d 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -720,7 +720,7 @@ ] }, "modifyAssignees": { -"description": "Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.", +"description": "Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees", "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees", "httpMethod": "POST", "id": "classroom.courses.announcements.modifyAssignees", @@ -1240,7 +1240,7 @@ ] }, "modifyAssignees": { -"description": "Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.", +"description": "Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees", "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees", "httpMethod": "POST", "id": "classroom.courses.courseWork.modifyAssignees", @@ -4107,7 +4107,7 @@ } } }, -"revision": "20250810", +"revision": "20250827", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index 52a313a7296..268e581b1df 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2573,7 +2573,7 @@ } } }, -"revision": "20250801", +"revision": "20250903", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -4911,7 +4911,7 @@ false "id": "NpmPackage", "properties": { "packagePath": { -"description": "Path to the package.json. e.g. workspace/path/to/package", +"description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json index 15fa1cada38..45ac5d659de 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json @@ -371,7 +371,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1087,7 +1087,7 @@ } } }, -"revision": "20250814", +"revision": "20250903", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json index 8223ce4f949..1fa4ee0dd5f 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json @@ -750,7 +750,7 @@ } } }, -"revision": "20250814", +"revision": "20250902", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -2140,6 +2140,7 @@ "enum": [ "UPGRADE_STATE_UNSPECIFIED", "ELIGIBLE_FOR_2ND_GEN_UPGRADE", +"INELIGIBLE_FOR_UPGRADE_UNTIL_REDEPLOYMENT", "UPGRADE_OPERATION_IN_PROGRESS", "SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL", "SETUP_FUNCTION_UPGRADE_CONFIG_ERROR", @@ -2151,7 +2152,8 @@ ], "enumDescriptions": [ "Unspecified state. Most functions are in this upgrade state.", -"Functions in this state are eligible for 1st Gen -> 2nd Gen upgrade.", +"Functions in this state are eligible for 1st Gen upgrade.", +"Functions in this state are ineligible for 1st Gen upgrade until redeployment with newer runtime.", "An upgrade related operation is in progress.", "SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.", "SetupFunctionUpgradeConfig API was un-successful.", diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json index 551bd7f12e5..a63cb1e74ac 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json @@ -750,7 +750,7 @@ } } }, -"revision": "20250814", +"revision": "20250902", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -2140,6 +2140,7 @@ "enum": [ "UPGRADE_STATE_UNSPECIFIED", "ELIGIBLE_FOR_2ND_GEN_UPGRADE", +"INELIGIBLE_FOR_UPGRADE_UNTIL_REDEPLOYMENT", "UPGRADE_OPERATION_IN_PROGRESS", "SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL", "SETUP_FUNCTION_UPGRADE_CONFIG_ERROR", @@ -2151,7 +2152,8 @@ ], "enumDescriptions": [ "Unspecified state. Most functions are in this upgrade state.", -"Functions in this state are eligible for 1st Gen -> 2nd Gen upgrade.", +"Functions in this state are eligible for 1st Gen upgrade.", +"Functions in this state are ineligible for 1st Gen upgrade until redeployment with newer runtime.", "An upgrade related operation is in progress.", "SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.", "SetupFunctionUpgradeConfig API was un-successful.", diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json index c3f624de4e9..70200984eb1 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json @@ -750,7 +750,7 @@ } } }, -"revision": "20250814", +"revision": "20250902", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -2140,6 +2140,7 @@ "enum": [ "UPGRADE_STATE_UNSPECIFIED", "ELIGIBLE_FOR_2ND_GEN_UPGRADE", +"INELIGIBLE_FOR_UPGRADE_UNTIL_REDEPLOYMENT", "UPGRADE_OPERATION_IN_PROGRESS", "SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL", "SETUP_FUNCTION_UPGRADE_CONFIG_ERROR", @@ -2151,7 +2152,8 @@ ], "enumDescriptions": [ "Unspecified state. Most functions are in this upgrade state.", -"Functions in this state are eligible for 1st Gen -> 2nd Gen upgrade.", +"Functions in this state are eligible for 1st Gen upgrade.", +"Functions in this state are ineligible for 1st Gen upgrade until redeployment with newer runtime.", "An upgrade related operation is in progress.", "SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.", "SetupFunctionUpgradeConfig API was un-successful.", diff --git a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json new file mode 100644 index 00000000000..c5b4e833617 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json @@ -0,0 +1,472 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://cloudlocationfinder.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Cloud Location Finder", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/location-finder/docs", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "cloudlocationfinder:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://cloudlocationfinder.mtls.googleapis.com/", +"name": "cloudlocationfinder", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "cloudlocationfinder.projects.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service.", +"flatPath": "v1/projects/{projectsId}/locations", +"httpMethod": "GET", +"id": "cloudlocationfinder.projects.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"extraLocationTypes": { +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"location": "query", +"repeated": true, +"type": "string" +}, +"filter": { +"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"name": { +"description": "The resource that owns the locations collection, if applicable.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The maximum number of results to return. If not set, the service selects a default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"cloudLocations": { +"methods": { +"get": { +"description": "Retrieves a resource containing information about a cloud location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudLocations/{cloudLocationsId}", +"httpMethod": "GET", +"id": "cloudlocationfinder.projects.locations.cloudLocations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/cloudLocations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "CloudLocation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists cloud locations under a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudLocations", +"httpMethod": "GET", +"id": "cloudlocationfinder.projects.locations.cloudLocations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters resources listed in the response. The expression is in the form of field=value. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION'. Multiple filter queries are space-separated. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code=\"US\"' By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of cloud locations to return per page. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Provide page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/cloudLocations", +"response": { +"$ref": "ListCloudLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"search": { +"description": "Searches for cloud locations from a given source location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudLocations:search", +"httpMethod": "GET", +"id": "cloudlocationfinder.projects.locations.cloudLocations.search", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"query": { +"description": "Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements.", +"location": "query", +"type": "string" +}, +"sourceCloudLocation": { +"description": "Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/cloudLocations:search", +"response": { +"$ref": "SearchCloudLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +}, +"revision": "20250905", +"rootUrl": "https://cloudlocationfinder.googleapis.com/", +"schemas": { +"CloudLocation": { +"description": "Represents resource cloud locations.", +"id": "CloudLocation", +"properties": { +"carbonFreeEnergyPercentage": { +"description": "Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.", +"format": "float", +"type": "number" +}, +"cloudLocationType": { +"description": "Optional. The type of the cloud location.", +"enum": [ +"CLOUD_LOCATION_TYPE_UNSPECIFIED", +"CLOUD_LOCATION_TYPE_REGION", +"CLOUD_LOCATION_TYPE_ZONE", +"CLOUD_LOCATION_TYPE_REGION_EXTENSION", +"CLOUD_LOCATION_TYPE_GDCC_ZONE" +], +"enumDescriptions": [ +"Unspecified type.", +"CloudLocation type for region.", +"CloudLocation type for zone.", +"CloudLocation type for region extension.", +"CloudLocation type for Google Distributed Cloud Connected Zone." +], +"type": "string" +}, +"cloudProvider": { +"description": "Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.", +"enum": [ +"CLOUD_PROVIDER_UNSPECIFIED", +"CLOUD_PROVIDER_GCP", +"CLOUD_PROVIDER_AWS", +"CLOUD_PROVIDER_AZURE", +"CLOUD_PROVIDER_OCI" +], +"enumDescriptions": [ +"Unspecified type.", +"Cloud provider type for Google Cloud.", +"Cloud provider type for AWS.", +"Cloud provider type for Azure.", +"Cloud provider type for OCI." +], +"type": "string" +}, +"containingCloudLocation": { +"description": "Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.", +"type": "string" +}, +"name": { +"description": "Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`", +"type": "string" +}, +"territoryCode": { +"description": "Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.", +"type": "string" +} +}, +"type": "object" +}, +"ListCloudLocationsResponse": { +"description": "Message for response to listing cloud locations.", +"id": "ListCloudLocationsResponse", +"properties": { +"cloudLocations": { +"description": "Output only. List of cloud locations.", +"items": { +"$ref": "CloudLocation" +}, +"readOnly": true, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"Location": { +"description": "A resource that represents a Google Cloud location.", +"id": "Location", +"properties": { +"displayName": { +"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", +"type": "object" +}, +"locationId": { +"description": "The canonical id for this location. For example: `\"us-east1\"`.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata. For example the available capacity at the given location.", +"type": "object" +}, +"name": { +"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"type": "string" +} +}, +"type": "object" +}, +"SearchCloudLocationsResponse": { +"description": "Message for response to searching cloud locations.", +"id": "SearchCloudLocationsResponse", +"properties": { +"cloudLocations": { +"description": "Output only. List of cloud locations.", +"items": { +"$ref": "CloudLocation" +}, +"readOnly": true, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Cloud Location Finder API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json index c0140e50355..b5b9abdafa3 100644 --- a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -304,7 +304,7 @@ } } }, -"revision": "20250814", +"revision": "20250905", "rootUrl": "https://cloudlocationfinder.googleapis.com/", "schemas": { "CloudLocation": { diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index b14e53a69e5..cacc4702423 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -697,7 +697,7 @@ ], "parameters": { "authorizedViewSetId": { -"description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See aip.dev/122#resource-id-segments", +"description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "location": "query", "type": "string" }, @@ -869,7 +869,7 @@ ], "parameters": { "authorizedViewId": { -"description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See aip.dev/122#resource-id-segments", +"description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "location": "query", "type": "string" }, @@ -5638,7 +5638,7 @@ } } }, -"revision": "20250825", +"revision": "20250901", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -10354,7 +10354,7 @@ true "additionalProperties": { "type": "string" }, -"description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"ingest-conversations\": Notify each time an IngestConversations LRO is complete. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. * \"upload-conversation\": Notify when an UploadConversation LRO is complete. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", +"description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"ingest-conversations\": Notify each time an IngestConversations LRO is complete. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. * \"upload-conversation\": Notify when an UploadConversation LRO is complete. * \"update-or-analyze-conversation\": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", "type": "object" }, "redactionConfig": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index 6f6028c4ab6..a3314bccaad 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -1715,7 +1715,7 @@ } } }, -"revision": "20250813", +"revision": "20250829", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2986,7 +2986,7 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage", "properties": { "packagePath": { -"description": "Path to the package.json. e.g. workspace/path/to/package", +"description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index 8321d07e582..86c6b639fea 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -1452,7 +1452,7 @@ } } }, -"revision": "20250813", +"revision": "20250829", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -2530,7 +2530,7 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage", "properties": { "packagePath": { -"description": "Path to the package.json. e.g. workspace/path/to/package", +"description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index fb4692ce4df..b0be277c162 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -1771,7 +1771,7 @@ } } }, -"revision": "20250813", +"revision": "20250829", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2912,7 +2912,7 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage", "properties": { "packagePath": { -"description": "Path to the package.json. e.g. workspace/path/to/package", +"description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/googleapiclient/discovery_cache/documents/datafusion.v1.json b/googleapiclient/discovery_cache/documents/datafusion.v1.json index 2d877d8fd38..d7eb80e7661 100644 --- a/googleapiclient/discovery_cache/documents/datafusion.v1.json +++ b/googleapiclient/discovery_cache/documents/datafusion.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -743,7 +743,7 @@ } } }, -"revision": "20250610", +"revision": "20250901", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -998,11 +998,13 @@ "items": { "enum": [ "DISABLED_REASON_UNSPECIFIED", -"KMS_KEY_ISSUE" +"KMS_KEY_ISSUE", +"PROJECT_STATE_OFF" ], "enumDescriptions": [ "This is an unknown reason for disabling.", -"The KMS key used by the instance is either revoked or denied access to" +"The KMS key used by the instance is either revoked or denied access to", +"The consumer project is in a non-ACTIVE state." ], "type": "string" }, @@ -1125,7 +1127,8 @@ "UPDATING", "AUTO_UPDATING", "AUTO_UPGRADING", -"DISABLED" +"DISABLED", +"ENABLING" ], "enumDescriptions": [ "Instance does not have a state yet", @@ -1138,7 +1141,8 @@ "Instance is being updated on customer request", "Instance is being auto-updated", "Instance is being auto-upgraded", -"Instance is disabled" +"Instance is disabled", +"Instance is being enabled." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/datafusion.v1beta1.json b/googleapiclient/discovery_cache/documents/datafusion.v1beta1.json index 85de3e79aa6..f6164856f31 100644 --- a/googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datafusion.v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -941,7 +941,7 @@ } } }, -"revision": "20250610", +"revision": "20250901", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -1211,11 +1211,13 @@ "items": { "enum": [ "DISABLED_REASON_UNSPECIFIED", -"KMS_KEY_ISSUE" +"KMS_KEY_ISSUE", +"PROJECT_STATE_OFF" ], "enumDescriptions": [ "This is an unknown reason for disabling.", -"The KMS key used by the instance is either revoked or denied access to" +"The KMS key used by the instance is either revoked or denied access to", +"The consumer project is in a non-ACTIVE state." ], "type": "string" }, @@ -1338,7 +1340,8 @@ "UPDATING", "AUTO_UPDATING", "AUTO_UPGRADING", -"DISABLED" +"DISABLED", +"ENABLING" ], "enumDescriptions": [ "Instance does not have a state yet", @@ -1351,7 +1354,8 @@ "Instance is being updated on customer request", "Instance is being auto-updated", "Instance is being auto-upgraded", -"Instance is disabled" +"Instance is disabled", +"Instance is being enabled." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json index 450ddde8d7e..2f52cc0095d 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json @@ -1676,7 +1676,7 @@ } } }, -"revision": "20250822", +"revision": "20250828", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2271,6 +2271,7 @@ "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them." }, "updateMask": { +"description": "Update mask for the policy.", "format": "google-fieldmask", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json index 4b7e7a5878b..436e68b6c30 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json @@ -1028,7 +1028,7 @@ } } }, -"revision": "20250822", +"revision": "20250828", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1385,6 +1385,7 @@ "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them." }, "updateMask": { +"description": "Update mask for the policy.", "format": "google-fieldmask", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json index 548f8b72eb5..b8e5bf24f8e 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json @@ -1636,7 +1636,7 @@ } } }, -"revision": "20250822", +"revision": "20250828", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2197,6 +2197,7 @@ "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them." }, "updateMask": { +"description": "Update mask for the policy.", "format": "google-fieldmask", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 01c37373545..af2cc920513 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -4407,7 +4407,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -8962,7 +8962,7 @@ } } }, -"revision": "20250812", +"revision": "20250902", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 309f42990d9..e699c525e40 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5309,7 +5309,7 @@ } } }, -"revision": "20250812", +"revision": "20250902", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index a0f00f2d8fc..6a51b19b274 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -807,7 +807,7 @@ "policies": { "methods": { "create": { -"description": "Creates a new Policy.", +"description": "Creates a new policy.", "flatPath": "dns/v1/projects/{project}/policies", "httpMethod": "POST", "id": "dns.policies.create", @@ -840,7 +840,7 @@ ] }, "delete": { -"description": "Deletes a previously created Policy. Fails if the policy is still being referenced by a network.", +"description": "Deletes a previously created policy. Fails if the policy is still being referenced by a network.", "flatPath": "dns/v1/projects/{project}/policies/{policy}", "httpMethod": "DELETE", "id": "dns.policies.delete", @@ -874,7 +874,7 @@ ] }, "get": { -"description": "Fetches the representation of an existing Policy.", +"description": "Fetches the representation of an existing policy.", "flatPath": "dns/v1/projects/{project}/policies/{policy}", "httpMethod": "GET", "id": "dns.policies.get", @@ -913,7 +913,7 @@ ] }, "list": { -"description": "Enumerates all Policies associated with a project.", +"description": "Enumerates all policies associated with a project.", "flatPath": "dns/v1/projects/{project}/policies", "httpMethod": "GET", "id": "dns.policies.list", @@ -951,7 +951,7 @@ ] }, "patch": { -"description": "Applies a partial update to an existing Policy.", +"description": "Applies a partial update to an existing policy.", "flatPath": "dns/v1/projects/{project}/policies/{policy}", "httpMethod": "PATCH", "id": "dns.policies.patch", @@ -991,7 +991,7 @@ ] }, "update": { -"description": "Updates an existing Policy.", +"description": "Updates an existing policy.", "flatPath": "dns/v1/projects/{project}/policies/{policy}", "httpMethod": "PUT", "id": "dns.policies.update", @@ -1237,7 +1237,7 @@ "type": "integer" }, "name": { -"description": "Restricts the list to return only records with this fully qualified domain name.", +"description": "Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field.", "location": "query", "type": "string" }, @@ -1253,7 +1253,7 @@ "type": "string" }, "type": { -"description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present.", +"description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present. Mutually exclusive with the {@code filter} field.", "location": "query", "type": "string" } @@ -1824,7 +1824,7 @@ } } }, -"revision": "20250411", +"revision": "20250828", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2759,7 +2759,7 @@ }, "dns64Config": { "$ref": "PolicyDns64Config", -"description": "Configurations related to DNS64 for this Policy." +"description": "Configurations related to DNS64 for this policy." }, "enableInboundForwarding": { "description": "Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.", @@ -2858,7 +2858,7 @@ "id": "PolicyDns64ConfigScope", "properties": { "allQueries": { -"description": "Controls whether DNS64 is enabled globally at the network level.", +"description": "Controls whether DNS64 is enabled globally for all networks bound to the policy.", "type": "boolean" }, "kind": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index 953491e83fa..5014c18f62a 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -807,7 +807,7 @@ "policies": { "methods": { "create": { -"description": "Creates a new Policy.", +"description": "Creates a new policy.", "flatPath": "dns/v1beta2/projects/{project}/policies", "httpMethod": "POST", "id": "dns.policies.create", @@ -840,7 +840,7 @@ ] }, "delete": { -"description": "Deletes a previously created Policy. Fails if the policy is still being referenced by a network.", +"description": "Deletes a previously created policy. Fails if the policy is still being referenced by a network.", "flatPath": "dns/v1beta2/projects/{project}/policies/{policy}", "httpMethod": "DELETE", "id": "dns.policies.delete", @@ -874,7 +874,7 @@ ] }, "get": { -"description": "Fetches the representation of an existing Policy.", +"description": "Fetches the representation of an existing policy.", "flatPath": "dns/v1beta2/projects/{project}/policies/{policy}", "httpMethod": "GET", "id": "dns.policies.get", @@ -913,7 +913,7 @@ ] }, "list": { -"description": "Enumerates all Policies associated with a project.", +"description": "Enumerates all policies associated with a project.", "flatPath": "dns/v1beta2/projects/{project}/policies", "httpMethod": "GET", "id": "dns.policies.list", @@ -951,7 +951,7 @@ ] }, "patch": { -"description": "Applies a partial update to an existing Policy.", +"description": "Applies a partial update to an existing policy.", "flatPath": "dns/v1beta2/projects/{project}/policies/{policy}", "httpMethod": "PATCH", "id": "dns.policies.patch", @@ -991,7 +991,7 @@ ] }, "update": { -"description": "Updates an existing Policy.", +"description": "Updates an existing policy.", "flatPath": "dns/v1beta2/projects/{project}/policies/{policy}", "httpMethod": "PUT", "id": "dns.policies.update", @@ -1234,7 +1234,7 @@ "type": "integer" }, "name": { -"description": "Restricts the list to return only records with this fully qualified domain name.", +"description": "Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field.", "location": "query", "type": "string" }, @@ -1250,7 +1250,7 @@ "type": "string" }, "type": { -"description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present.", +"description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present. Mutually exclusive with the {@code filter} field.", "location": "query", "type": "string" } @@ -1821,7 +1821,7 @@ } } }, -"revision": "20250411", +"revision": "20250828", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2756,7 +2756,7 @@ }, "dns64Config": { "$ref": "PolicyDns64Config", -"description": "Configurations related to DNS64 for this Policy." +"description": "Configurations related to DNS64 for this policy." }, "enableInboundForwarding": { "description": "Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.", @@ -2855,7 +2855,7 @@ "id": "PolicyDns64ConfigScope", "properties": { "allQueries": { -"description": "Controls whether DNS64 is enabled globally at the network level.", +"description": "Controls whether DNS64 is enabled globally for all networks bound to the policy.", "type": "boolean" }, "kind": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 267d133ceed..881ecee1c72 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -187,7 +187,7 @@ ], "parameters": { "databaseId": { -"description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid.", +"description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid if the database is Standard edition.", "location": "query", "type": "string" }, @@ -1824,7 +1824,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1956,7 +1956,7 @@ } } }, -"revision": "20250811", +"revision": "20250824", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2933,7 +2933,7 @@ "id": "GoogleFirestoreAdminV1CloneDatabaseRequest", "properties": { "databaseId": { -"description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid.", +"description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid if the database is Standard edition.", "type": "string" }, "encryptionConfig": { @@ -3973,7 +3973,7 @@ "type": "string" }, "databaseId": { -"description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid.", +"description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database ID is also valid if the database is Standard edition.", "type": "string" }, "encryptionConfig": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 2d77fb0022f..e8b6178c4a4 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2117,7 +2117,7 @@ } } }, -"revision": "20250815", +"revision": "20250829", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2510,8 +2510,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE", -"FORCED_COMPLETE" +"COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -2520,8 +2519,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", -"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index f074568e40a..99110b48029 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2261,7 +2261,7 @@ } } }, -"revision": "20250815", +"revision": "20250829", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2750,8 +2750,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE", -"FORCED_COMPLETE" +"COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -2760,8 +2759,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", -"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 5e40de2f383..1facef31307 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2117,7 +2117,7 @@ } } }, -"revision": "20250815", +"revision": "20250829", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2510,8 +2510,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE", -"FORCED_COMPLETE" +"COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -2520,8 +2519,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", -"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2.json b/googleapiclient/discovery_cache/documents/gkehub.v2.json index 053d153a287..94edec2d275 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2.json @@ -477,7 +477,7 @@ } } }, -"revision": "20250815", +"revision": "20250829", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -626,8 +626,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE", -"FORCED_COMPLETE" +"COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -636,8 +635,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", -"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index ddd4fc98f76..5ebf5271f9e 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -477,7 +477,7 @@ } } }, -"revision": "20250815", +"revision": "20250829", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -626,8 +626,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE", -"FORCED_COMPLETE" +"COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -636,8 +635,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", -"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json index f174715055e..0f9216ab894 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json @@ -477,7 +477,7 @@ } } }, -"revision": "20250815", +"revision": "20250829", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -626,8 +626,7 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE", -"FORCED_COMPLETE" +"COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -636,8 +635,7 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", -"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json index b37910d5831..46b02e8c374 100644 --- a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240701", +"revision": "20250901", "rootUrl": "https://groupsmigration.googleapis.com/", "schemas": { "Groups": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json index 975b3e2d9cf..0f5c4947029 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json @@ -1543,7 +1543,7 @@ ], "parameters": { "parent": { -"description": "Required. The account to create a region for. Format: `accounts/{account}`", +"description": "Required. The account to delete one or more regions from. Format: `accounts/{account}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -2361,7 +2361,7 @@ } } }, -"revision": "20250826", +"revision": "20250830", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -2806,7 +2806,7 @@ "id": "BatchDeleteRegionsRequest", "properties": { "requests": { -"description": "Required. The names of the regions to delete. A maximum of 1000 regions can be deleted in a batch.", +"description": "Required. The names of the regions to delete. A maximum of 100 regions can be deleted in a batch.", "items": { "$ref": "DeleteRegionRequest" }, @@ -4753,7 +4753,7 @@ false "type": "object" }, "Program": { -"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", +"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index ecbabca1b34..a8242986b9c 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -2311,7 +2311,7 @@ } } }, -"revision": "20250826", +"revision": "20250830", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -4630,7 +4630,7 @@ false "type": "object" }, "Program": { -"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", +"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json index d16752b4f60..89654e6a9e4 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json @@ -268,7 +268,7 @@ } } }, -"revision": "20250621", +"revision": "20250830", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -653,14 +653,16 @@ false "REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER", "REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER", "LEGAL_APPEAL_IN_HELP_CENTER", -"VERIFY_IDENTITY_IN_MERCHANT_CENTER" +"VERIFY_IDENTITY_IN_MERCHANT_CENTER", +"VERIFY_BUSINESS_VIDEO_IN_MERCHANT_CENTER" ], "enumDescriptions": [ "Default value. Will never be provided by the API.", "Redirect to Merchant Center where the business can request a review for issue related to their product.", "Redirect to Merchant Center where the business can request a review for issue related to their account.", "Redirect to the form in Help Center where the business can request a legal appeal for the issue.", -"Redirect to Merchant Center where the business can perform identity verification." +"Redirect to Merchant Center where the business can perform identity verification.", +"Redirect to Merchant Center where the business can perform business video verification." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json index 2f3ffebeabb..26b2e16328c 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2407,7 +2407,7 @@ } } }, -"revision": "20250814", +"revision": "20250904", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index 69d555ab97e..cdc9be04e85 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2554,7 +2554,7 @@ } } }, -"revision": "20250814", +"revision": "20250904", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { diff --git a/googleapiclient/discovery_cache/documents/ml.v1.json b/googleapiclient/discovery_cache/documents/ml.v1.json index 18b7ffebe05..5c808037db2 100644 --- a/googleapiclient/discovery_cache/documents/ml.v1.json +++ b/googleapiclient/discovery_cache/documents/ml.v1.json @@ -1486,7 +1486,7 @@ } } }, -"revision": "20250503", +"revision": "20250823", "rootUrl": "https://ml.googleapis.com/", "schemas": { "GoogleApi__HttpBody": { @@ -2993,7 +2993,7 @@ "id": "GoogleCloudMlV1__RequestLoggingConfig", "properties": { "bigqueryTableName": { -"description": "Required. Fully qualified BigQuery table name in the following format: \" project_id.dataset_name.table_name\" The specified table must already exist, and the \"Cloud ML Service Agent\" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE ", +"description": "Required. Fully qualified BigQuery table name in the following format: \" project_id.dataset_name.table_name\" The specified table must already exist, and the \"Cloud ML Service Agent\" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE ", "type": "string" }, "samplingPercentage": { diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index 548274acc3d..d079015d127 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -5513,7 +5513,7 @@ } } }, -"revision": "20250822", +"revision": "20250903", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -8862,13 +8862,15 @@ "PROFILE_TYPE_UNSPECIFIED", "THREAT_PREVENTION", "CUSTOM_MIRRORING", -"CUSTOM_INTERCEPT" +"CUSTOM_INTERCEPT", +"URL_FILTERING" ], "enumDescriptions": [ "Profile type not specified.", "Profile type for threat prevention.", "Profile type for packet mirroring v2", -"Profile type for TPPI." +"Profile type for TPPI.", +"Profile type for URL filtering." ], "type": "string" }, @@ -8877,6 +8879,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"urlFilteringProfile": { +"$ref": "UrlFilteringProfile", +"description": "The URL filtering configuration for the SecurityProfile." } }, "type": "object" @@ -8934,6 +8940,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"urlFilteringProfile": { +"description": "Optional. Reference to a SecurityProfile with the UrlFiltering configuration.", +"type": "string" } }, "type": "object" @@ -9237,6 +9247,53 @@ }, "type": "object" }, +"UrlFilter": { +"description": "A URL filter defines an action to take for some URL match.", +"id": "UrlFilter", +"properties": { +"filteringAction": { +"description": "Required. The action taken when this filter is applied.", +"enum": [ +"URL_FILTERING_ACTION_UNSPECIFIED", +"ALLOW", +"DENY" +], +"enumDescriptions": [ +"Filtering action not specified.", +"The connection matching this filter will be allowed to transmit.", +"The connection matching this filter will be dropped." +], +"type": "string" +}, +"priority": { +"description": "Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.", +"format": "int32", +"type": "integer" +}, +"urls": { +"description": "Required. The list of strings that a URL must match with for this filter to be applied.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"UrlFilteringProfile": { +"description": "UrlFilteringProfile defines filters based on URL.", +"id": "UrlFilteringProfile", +"properties": { +"urlFilters": { +"description": "Optional. The list of filtering configs in which each config defines an action to take for some URL match.", +"items": { +"$ref": "UrlFilter" +}, +"type": "array" +} +}, +"type": "object" +}, "UrlList": { "description": "UrlList proto helps users to set reusable, independently manageable lists of hosts, host patterns, URLs, URL patterns.", "id": "UrlList", diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 8bf9f295db7..aeeddf619cb 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2859,7 +2859,7 @@ } } }, -"revision": "20250807", +"revision": "20250828", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4700,9 +4700,9 @@ ], "enumDescriptions": [ "Default value.", -"Disable Conversational Filtering.", -"Enabled Conversational Filtering with default Conversational Search.", -"Enabled Conversational Filtering without default Conversational Search." +"Disables Conversational Filtering when using Conversational Search.", +"Enables Conversational Filtering when using Conversational Search.", +"Enables Conversational Filtering without Conversational Search." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 7ab03570095..23dafcb9fed 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2887,7 +2887,7 @@ } } }, -"revision": "20250822", +"revision": "20250829", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4707,7 +4707,7 @@ false "id": "GoogleDevtoolsCloudbuildV1NpmPackage", "properties": { "packagePath": { -"description": "Path to the package.json. e.g. workspace/path/to/package", +"description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 48c0e5f8492..4fac0c7e97b 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1922,7 +1922,7 @@ } } }, -"revision": "20250818", +"revision": "20250829", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -3762,7 +3762,7 @@ "type": "integer" }, "items": { -"description": "If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.", +"description": "If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.", "items": { "$ref": "GoogleCloudRunV2VersionToPath" }, @@ -5920,7 +5920,7 @@ false "id": "GoogleDevtoolsCloudbuildV1NpmPackage", "properties": { "packagePath": { -"description": "Path to the package.json. e.g. workspace/path/to/package", +"description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" }, "repository": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index 0e022995586..3d87237303a 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -338,7 +338,7 @@ } } }, -"revision": "20250813", +"revision": "20250827", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -424,11 +424,11 @@ "type": "string" }, "subjectToken": { -"description": "Required. The input token. This token is either an external credential issued by a workload identity pool provider, or a short-lived access token issued by Google. If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523](https://tools.ietf.org/html/rfc7523), and the `subject_token_type` must be either `urn:ietf:params:oauth:token-type:jwt` or `urn:ietf:params:oauth:token-type:id_token`. The following headers are required: - `kid`: The identifier of the signing key securing the JWT. - `alg`: The cryptographic algorithm securing the JWT. Must be `RS256` or `ES256`. The following payload fields are required. For more information, see [RFC 7523, Section 3](https://tools.ietf.org/html/rfc7523#section-3): - `iss`: The issuer of the token. The issuer must provide a discovery document at the URL `/.well-known/openid-configuration`, where `` is the value of this field. The document must be formatted according to section 4.2 of the [OIDC 1.0 Discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). - `iat`: The issue time, in seconds, since the Unix epoch. Must be in the past. - `exp`: The expiration time, in seconds, since the Unix epoch. Must be less than 48 hours after `iat`. Shorter expiration times are more secure. If possible, we recommend setting an expiration time less than 6 hours. - `sub`: The identity asserted in the JWT. - `aud`: For workload identity pools, this must be a value specified in the allowed audiences for the workload identity pool provider, or one of the audiences allowed by default if no audiences were specified. See https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers#oidc. For workforce pools, this must match the client ID specified in the provider configuration. See https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools.providers#oidc. Example header: ``` { \"alg\": \"RS256\", \"kid\": \"us-east-11\" } ``` Example payload: ``` { \"iss\": \"https://accounts.google.com\", \"iat\": 1517963104, \"exp\": 1517966704, \"aud\": \"//iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/providers/my-provider\", \"sub\": \"113475438248934895348\", \"my_claims\": { \"additional_claim\": \"value\" } } ``` If `subject_token` is for AWS, it must be a serialized `GetCallerIdentity` token. This token contains the same information as a request to the AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity) method, as well as the AWS [signature](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-type:aws4_request`. The following parameters are required: - `url`: The URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints are also supported. - `method`: The HTTP request method: `POST`. - `headers`: The HTTP request headers, which must include: - `Authorization`: The request signature. - `x-amz-date`: The time you will send the request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date) string. This value is typically set to the current time and is used to help prevent replay attacks. - `host`: The hostname of the `url` field; for example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full, canonical resource name of the workload identity pool provider, with or without an `https:` prefix. To help ensure data integrity, we recommend including this header in the `SignedHeaders` field of the signed request. For example: //iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ If you are using temporary security credentials provided by AWS, you must also include the header `x-amz-security-token`, with the value set to the session token. The following example shows a `GetCallerIdentity` token: ``` { \"headers\": [ {\"key\": \"x-amz-date\", \"value\": \"20200815T015049Z\"}, {\"key\": \"Authorization\", \"value\": \"AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$signature\"}, {\"key\": \"x-goog-cloud-target-resource\", \"value\": \"//iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/\"}, {\"key\": \"host\", \"value\": \"sts.amazonaws.com\"} . ], \"method\": \"POST\", \"url\": \"https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15\" } ``` If the token is a SAML 2.0 assertion, it must use the format defined in [the SAML 2.0 spec](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.pdf), and the `subject_token_type` must be `urn:ietf:params:oauth:token-type:saml2`. See [Verification of external credentials](https://cloud.google.com/iam/docs/using-workload-identity-federation#verification_of_external_credentials) for details on how SAML 2.0 assertions are validated during token exchanges. You can also use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. In this case, set `subject_token_type` to `urn:ietf:params:oauth:token-type:access_token`. If an access token already contains security attributes, you cannot apply additional security attributes.", +"description": "Required. The input token. This token is either an external credential issued by a workload identity pool provider, or a short-lived access token issued by Google. If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523](https://tools.ietf.org/html/rfc7523), and the `subject_token_type` must be either `urn:ietf:params:oauth:token-type:jwt` or `urn:ietf:params:oauth:token-type:id_token`. The following headers are required: - `kid`: The identifier of the signing key securing the JWT. - `alg`: The cryptographic algorithm securing the JWT. Must be `RS256` or `ES256`. The following payload fields are required. For more information, see [RFC 7523, Section 3](https://tools.ietf.org/html/rfc7523#section-3): - `iss`: The issuer of the token. The issuer must provide a discovery document at the URL `/.well-known/openid-configuration`, where `` is the value of this field. The document must be formatted according to section 4.2 of the [OIDC 1.0 Discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). - `iat`: The issue time, in seconds, since the Unix epoch. Must be in the past. - `exp`: The expiration time, in seconds, since the Unix epoch. Must be less than 48 hours after `iat`. Shorter expiration times are more secure. If possible, we recommend setting an expiration time less than 6 hours. - `sub`: The identity asserted in the JWT. - `aud`: For workload identity pools, this must be a value specified in the allowed audiences for the workload identity pool provider, or one of the audiences allowed by default if no audiences were specified. See https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers#oidc. For workforce pools, this must match the client ID specified in the provider configuration. See https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools.providers#oidc. Example header: ``` { \"alg\": \"RS256\", \"kid\": \"us-east-11\" } ``` Example payload: ``` { \"iss\": \"https://accounts.google.com\", \"iat\": 1517963104, \"exp\": 1517966704, \"aud\": \"//iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/providers/my-provider\", \"sub\": \"113475438248934895348\", \"my_claims\": { \"additional_claim\": \"value\" } } ``` If `subject_token` is for AWS, it must be a serialized `GetCallerIdentity` token. This token contains the same information as a request to the AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity) method, as well as the AWS [signature](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) for the request information. Use Signature Version 4. Format the request as URL-encoded JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-type:aws4_request`. The following parameters are required: - `url`: The URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints are also supported. - `method`: The HTTP request method: `POST`. - `headers`: The HTTP request headers, which must include: - `Authorization`: The request signature. - `x-amz-date`: The time you will send the request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date) string. This value is typically set to the current time and is used to help prevent replay attacks. - `host`: The hostname of the `url` field; for example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full, canonical resource name of the workload identity pool provider, with or without an `https:` prefix. To help ensure data integrity, we recommend including this header in the `SignedHeaders` field of the signed request. For example: //iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/ If you are using temporary security credentials provided by AWS, you must also include the header `x-amz-security-token`, with the value set to the session token. The following example shows a `GetCallerIdentity` token: ``` { \"headers\": [ {\"key\": \"x-amz-date\", \"value\": \"20200815T015049Z\"}, {\"key\": \"Authorization\", \"value\": \"AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$signature\"}, {\"key\": \"x-goog-cloud-target-resource\", \"value\": \"//iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/\"}, {\"key\": \"host\", \"value\": \"sts.amazonaws.com\"} . ], \"method\": \"POST\", \"url\": \"https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15\" } ``` If the token is a SAML 2.0 assertion, it must use the format defined in [the SAML 2.0 spec](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.pdf), and the `subject_token_type` must be `urn:ietf:params:oauth:token-type:saml2`. See [Verification of external credentials](https://cloud.google.com/iam/docs/using-workload-identity-federation#verification_of_external_credentials) for details on how SAML 2.0 assertions are validated during token exchanges. You can also use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. In this case, set `subject_token_type` to `urn:ietf:params:oauth:token-type:access_token`. If an access token already contains security attributes, you cannot apply additional security attributes. If the request is for X.509 certificate-based authentication, the `subject_token` must be a JSON-formatted list of X.509 certificates in DER format, as defined in [RFC 7515](https://www.rfc-editor.org/rfc/rfc7515#section-4.1.6). `subject_token_type` must be `urn:ietf:params:oauth:token-type:mtls`. The following example shows a JSON-formatted list of X.509 certificate in DER format: ``` [\\\"MIIEYDCCA0i...\\\", \\\"MCIFFGAGTT0...\\\"] ```", "type": "string" }, "subjectTokenType": { -"description": "Required. An identifier that indicates the type of the security token in the `subject_token` parameter. Supported values are `urn:ietf:params:oauth:token-type:jwt`, `urn:ietf:params:oauth:token-type:id_token`, `urn:ietf:params:aws:token-type:aws4_request`, `urn:ietf:params:oauth:token-type:access_token`, and `urn:ietf:params:oauth:token-type:saml2`.", +"description": "Required. An identifier that indicates the type of the security token in the `subject_token` parameter. Supported values are `urn:ietf:params:oauth:token-type:jwt`, `urn:ietf:params:oauth:token-type:id_token`, `urn:ietf:params:aws:token-type:aws4_request`, `urn:ietf:params:oauth:token-type:access_token`, `urn:ietf:params:oauth:token-type:mtls`, and `urn:ietf:params:oauth:token-type:saml2`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v3.json b/googleapiclient/discovery_cache/documents/trafficdirector.v3.json index 235e5335190..bd584431fb6 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v3.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v3.json @@ -128,7 +128,7 @@ } } }, -"revision": "20250618", +"revision": "20250827", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { @@ -1118,7 +1118,7 @@ "type": "string" }, "networkNamespaceFilepath": { -"description": "Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. note:: Currently only used for Listener sockets. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect.", +"description": "Filepath that specifies the Linux network namespace this socket will be created in (see ``man 7 network_namespaces``). If this field is set, Envoy will create the socket in the specified network namespace. .. note:: Setting this parameter requires Envoy to run with the ``CAP_NET_ADMIN`` capability. .. attention:: Network namespaces are only configurable on Linux. Otherwise, this field has no effect.", "type": "string" }, "portValue": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 57dea9a0516..1b2e39757e5 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2543,7 +2543,7 @@ } } }, -"revision": "20250824", +"revision": "20250904", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 821674e87f0..983f0a9ec21 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2543,7 +2543,7 @@ } } }, -"revision": "20250824", +"revision": "20250904", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": {